Merge fixes and tests for jra's broken strstr_m() function from 3.0
[samba.git] / source3 / lib / util_str.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Samba utility functions
4    
5    Copyright (C) Andrew Tridgell 1992-2001
6    Copyright (C) Simo Sorce      2001-2002
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 2 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, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 #include "includes.h"
25
26 /**
27  * @file
28  * @brief String utilities.
29  **/
30
31 /**
32  * Get the next token from a string, return False if none found.
33  * Handles double-quotes.
34  * 
35  * Based on a routine by GJC@VILLAGE.COM. 
36  * Extensively modified by Andrew.Tridgell@anu.edu.au
37  **/
38 BOOL next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
39 {
40         char *s;
41         char *pbuf;
42         BOOL quoted;
43         size_t len=1;
44
45         if (!ptr)
46                 return(False);
47
48         s = (char *)*ptr;
49
50         /* default to simple separators */
51         if (!sep)
52                 sep = " \t\n\r";
53
54         /* find the first non sep char */
55         while (*s && strchr_m(sep,*s))
56                 s++;
57         
58         /* nothing left? */
59         if (! *s)
60                 return(False);
61         
62         /* copy over the token */
63         pbuf = buff;
64         for (quoted = False; len < bufsize && *s && (quoted || !strchr_m(sep,*s)); s++) {
65                 if (*s == '\"' || *s == '\'') {
66                         quoted = !quoted;
67                 } else {
68                         len++;
69                         *pbuf++ = *s;
70                 }
71         }
72         
73         *ptr = (*s) ? s+1 : s;  
74         *pbuf = 0;
75         
76         return(True);
77 }
78
79 /**
80 This is like next_token but is not re-entrant and "remembers" the first 
81 parameter so you can pass NULL. This is useful for user interface code
82 but beware the fact that it is not re-entrant!
83 **/
84
85 static const char *last_ptr=NULL;
86
87 BOOL next_token_nr(const char **ptr,char *buff, const char *sep, size_t bufsize)
88 {
89         BOOL ret;
90         if (!ptr)
91                 ptr = &last_ptr;
92
93         ret = next_token(ptr, buff, sep, bufsize);
94         last_ptr = *ptr;
95         return ret;     
96 }
97
98 static uint16 tmpbuf[sizeof(pstring)];
99
100 void set_first_token(char *ptr)
101 {
102         last_ptr = ptr;
103 }
104
105 /**
106  Convert list of tokens to array; dependent on above routine.
107  Uses last_ptr from above - bit of a hack.
108 **/
109
110 char **toktocliplist(int *ctok, const char *sep)
111 {
112         char *s=(char *)last_ptr;
113         int ictok=0;
114         char **ret, **iret;
115
116         if (!sep)
117                 sep = " \t\n\r";
118
119         while(*s && strchr_m(sep,*s))
120                 s++;
121
122         /* nothing left? */
123         if (!*s)
124                 return(NULL);
125
126         do {
127                 ictok++;
128                 while(*s && (!strchr_m(sep,*s)))
129                         s++;
130                 while(*s && strchr_m(sep,*s))
131                         *s++=0;
132         } while(*s);
133         
134         *ctok=ictok;
135         s=(char *)last_ptr;
136         
137         if (!(ret=iret=malloc(ictok*sizeof(char *))))
138                 return NULL;
139         
140         while(ictok--) {    
141                 *iret++=s;
142                 while(*s++)
143                         ;
144                 while(!*s)
145                         s++;
146         }
147
148         return ret;
149 }
150
151 /**
152  * Case insensitive string compararison.
153  *
154  * iconv does not directly give us a way to compare strings in
155  * arbitrary unix character sets -- all we can is convert and then
156  * compare.  This is expensive.
157  *
158  * As an optimization, we do a first pass that considers only the
159  * prefix of the strings that is entirely 7-bit.  Within this, we
160  * check whether they have the same value.
161  *
162  * Hopefully this will often give the answer without needing to copy.
163  * In particular it should speed comparisons to literal ascii strings
164  * or comparisons of strings that are "obviously" different.
165  *
166  * If we find a non-ascii character we fall back to converting via
167  * iconv.
168  *
169  * This should never be slower than convering the whole thing, and
170  * often faster.
171  *
172  * A different optimization would be to compare for bitwise equality
173  * in the binary encoding.  (It would be possible thought hairy to do
174  * both simultaneously.)  But in that case if they turn out to be
175  * different, we'd need to restart the whole thing.
176  *
177  * Even better is to implement strcasecmp for each encoding and use a
178  * function pointer. 
179  **/
180 int StrCaseCmp(const char *s, const char *t)
181 {
182
183         const char * ps, * pt;
184         size_t size;
185         smb_ucs2_t *buffer_s, *buffer_t;
186         int ret;
187
188         for (ps = s, pt = t; ; ps++, pt++) {
189                 char us, ut;
190
191                 if (!*ps && !*pt)
192                         return 0; /* both ended */
193                 else if (!*ps)
194                         return -1; /* s is a prefix */
195                 else if (!*pt)
196                         return +1; /* t is a prefix */
197                 else if ((*ps & 0x80) || (*pt & 0x80))
198                         /* not ascii anymore, do it the hard way from here on in */
199                         break;
200
201                 us = toupper(*ps);
202                 ut = toupper(*pt);
203                 if (us == ut)
204                         continue;
205                 else if (us < ut)
206                         return -1;
207                 else if (us > ut)
208                         return +1;
209         }
210
211         size = push_ucs2_allocate(&buffer_s, s);
212         if (size == (size_t)-1) {
213                 return strcmp(s, t); 
214                 /* Not quite the right answer, but finding the right one
215                    under this failure case is expensive, and it's pretty close */
216         }
217         
218         size = push_ucs2_allocate(&buffer_t, t);
219         if (size == (size_t)-1) {
220                 SAFE_FREE(buffer_s);
221                 return strcmp(s, t); 
222                 /* Not quite the right answer, but finding the right one
223                    under this failure case is expensive, and it's pretty close */
224         }
225         
226         ret = strcasecmp_w(buffer_s, buffer_t);
227         SAFE_FREE(buffer_s);
228         SAFE_FREE(buffer_t);
229         return ret;
230 }
231
232
233 /**
234  Case insensitive string compararison, length limited.
235 **/
236 int StrnCaseCmp(const char *s, const char *t, size_t n)
237 {
238         pstring buf1, buf2;
239         unix_strupper(s, strlen(s)+1, buf1, sizeof(buf1));
240         unix_strupper(t, strlen(t)+1, buf2, sizeof(buf2));
241         return strncmp(buf1,buf2,n);
242 }
243
244 /**
245  * Compare 2 strings.
246  *
247  * @note The comparison is case-insensitive.
248  **/
249 BOOL strequal(const char *s1, const char *s2)
250 {
251         if (s1 == s2)
252                 return(True);
253         if (!s1 || !s2)
254                 return(False);
255   
256         return(StrCaseCmp(s1,s2)==0);
257 }
258
259 /**
260  * Compare 2 strings up to and including the nth char.
261  *
262  * @note The comparison is case-insensitive.
263  **/
264 BOOL strnequal(const char *s1,const char *s2,size_t n)
265 {
266   if (s1 == s2)
267           return(True);
268   if (!s1 || !s2 || !n)
269           return(False);
270   
271   return(StrnCaseCmp(s1,s2,n)==0);
272 }
273
274 /**
275  Compare 2 strings (case sensitive).
276 **/
277
278 BOOL strcsequal(const char *s1,const char *s2)
279 {
280   if (s1 == s2)
281           return(True);
282   if (!s1 || !s2)
283           return(False);
284   
285   return(strcmp(s1,s2)==0);
286 }
287
288 /**
289 Do a case-insensitive, whitespace-ignoring string compare.
290 **/
291
292 int strwicmp(const char *psz1, const char *psz2)
293 {
294         /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
295         /* appropriate value. */
296         if (psz1 == psz2)
297                 return (0);
298         else if (psz1 == NULL)
299                 return (-1);
300         else if (psz2 == NULL)
301                 return (1);
302
303         /* sync the strings on first non-whitespace */
304         while (1) {
305                 while (isspace((int)*psz1))
306                         psz1++;
307                 while (isspace((int)*psz2))
308                         psz2++;
309                 if (toupper(*psz1) != toupper(*psz2) || *psz1 == '\0'
310                     || *psz2 == '\0')
311                         break;
312                 psz1++;
313                 psz2++;
314         }
315         return (*psz1 - *psz2);
316 }
317
318
319 /**
320  Convert a string to upper case, but don't modify it.
321 **/
322
323 char *strupper_static(const char *s)
324 {
325         static pstring str;
326
327         pstrcpy(str, s);
328         strupper_m(str);
329
330         return str;
331 }
332
333 /**
334  Convert a string to "normal" form.
335 **/
336
337 void strnorm(char *s)
338 {
339         extern int case_default;
340         if (case_default == CASE_UPPER)
341                 strupper_m(s);
342         else
343                 strlower_m(s);
344 }
345
346 /**
347  Check if a string is in "normal" case.
348 **/
349
350 BOOL strisnormal(const char *s)
351 {
352         extern int case_default;
353         if (case_default == CASE_UPPER)
354                 return(!strhaslower(s));
355         
356         return(!strhasupper(s));
357 }
358
359
360 /**
361  String replace.
362  NOTE: oldc and newc must be 7 bit characters
363 **/
364
365 void string_replace(pstring s,char oldc,char newc)
366 {
367         unsigned char *p;
368
369         /* this is quite a common operation, so we want it to be
370            fast. We optimise for the ascii case, knowing that all our
371            supported multi-byte character sets are ascii-compatible
372            (ie. they match for the first 128 chars) */
373
374         for (p = (unsigned char *)s; *p; p++) {
375                 if (*p & 0x80) /* mb string - slow path. */
376                         break;
377                 if (*p == oldc)
378                         *p = newc;
379         }
380
381         if (!*p)
382                 return;
383
384         /* Slow (mb) path. */
385 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
386         /* With compose characters we must restart from the beginning. JRA. */
387         p = s;
388 #endif
389         push_ucs2(NULL, tmpbuf, p, sizeof(tmpbuf), STR_TERMINATE);
390         string_replace_w(tmpbuf, UCS2_CHAR(oldc), UCS2_CHAR(newc));
391         pull_ucs2(NULL, p, tmpbuf, -1, sizeof(tmpbuf), STR_TERMINATE);
392 }
393
394 /**
395  Skip past some strings in a buffer.
396 **/
397
398 char *skip_string(char *buf,size_t n)
399 {
400         while (n--)
401                 buf += strlen(buf) + 1;
402         return(buf);
403 }
404
405 /**
406  Count the number of characters in a string. Normally this will
407  be the same as the number of bytes in a string for single byte strings,
408  but will be different for multibyte.
409 **/
410
411 size_t str_charnum(const char *s)
412 {
413         uint16 tmpbuf2[sizeof(pstring)];
414         push_ucs2(NULL, tmpbuf2,s, sizeof(tmpbuf2), STR_TERMINATE);
415         return strlen_w(tmpbuf2);
416 }
417
418 /**
419  Count the number of characters in a string. Normally this will
420  be the same as the number of bytes in a string for single byte strings,
421  but will be different for multibyte.
422 **/
423
424 size_t str_ascii_charnum(const char *s)
425 {
426         pstring tmpbuf2;
427         push_ascii(tmpbuf2, s, sizeof(tmpbuf2), STR_TERMINATE);
428         return strlen(tmpbuf2);
429 }
430
431 BOOL trim_char(char *s,char cfront,char cback)
432 {
433         BOOL ret = False;
434         char *ep;
435         char *fp = s;
436
437         /* Ignore null or empty strings. */
438         if (!s || (s[0] == '\0'))
439                 return False;
440
441         if (cfront) {
442                 while (*fp && *fp == cfront)
443                         fp++;
444                 if (!*fp) {
445                         /* We ate the string. */
446                         s[0] = '\0';
447                         return True;
448                 }
449                 if (fp != s)
450                         ret = True;
451         }
452
453         ep = fp + strlen(fp) - 1;
454         if (cback) {
455                 /* Attempt ascii only. Bail for mb strings. */
456                 while ((ep >= fp) && (*ep == cback)) {
457                         ret = True;
458                         if ((ep > fp) && (((unsigned char)ep[-1]) & 0x80)) {
459                                 /* Could be mb... bail back to tim_string. */
460                                 char fs[2], bs[2];
461                                 if (cfront) {
462                                         fs[0] = cfront;
463                                         fs[1] = '\0';
464                                 }
465                                 bs[0] = cback;
466                                 bs[1] = '\0';
467                                 return trim_string(s, cfront ? fs : NULL, bs);
468                         } else {
469                                 ep--;
470                         }
471                 }
472                 if (ep < fp) {
473                         /* We ate the string. */
474                         s[0] = '\0';
475                         return True;
476                 }
477         }
478
479         ep[1] = '\0';
480         memmove(s, fp, ep-fp+2);
481         return ret;
482 }
483
484 /**
485  Trim the specified elements off the front and back of a string.
486 **/
487
488 BOOL trim_string(char *s,const char *front,const char *back)
489 {
490         BOOL ret = False;
491         size_t front_len;
492         size_t back_len;
493         size_t len;
494
495         /* Ignore null or empty strings. */
496         if (!s || (s[0] == '\0'))
497                 return False;
498
499         front_len       = front? strlen(front) : 0;
500         back_len        = back? strlen(back) : 0;
501
502         len = strlen(s);
503
504         if (front_len) {
505                 while (len && strncmp(s, front, front_len)==0) {
506                         /* Must use memmove here as src & dest can
507                          * easily overlap. Found by valgrind. JRA. */
508                         memmove(s, s+front_len, (len-front_len)+1);
509                         len -= front_len;
510                         ret=True;
511                 }
512         }
513         
514         if (back_len) {
515                 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
516                         s[len-back_len]='\0';
517                         len -= back_len;
518                         ret=True;
519                 }
520         }
521         return ret;
522 }
523
524 /**
525  Does a string have any uppercase chars in it?
526 **/
527
528 BOOL strhasupper(const char *s)
529 {
530         smb_ucs2_t *ptr;
531         push_ucs2(NULL, tmpbuf,s, sizeof(tmpbuf), STR_TERMINATE);
532         for(ptr=tmpbuf;*ptr;ptr++)
533                 if(isupper_w(*ptr))
534                         return True;
535         return(False);
536 }
537
538 /**
539  Does a string have any lowercase chars in it?
540 **/
541
542 BOOL strhaslower(const char *s)
543 {
544         smb_ucs2_t *ptr;
545         push_ucs2(NULL, tmpbuf,s, sizeof(tmpbuf), STR_TERMINATE);
546         for(ptr=tmpbuf;*ptr;ptr++)
547                 if(islower_w(*ptr))
548                         return True;
549         return(False);
550 }
551
552 /**
553  Find the number of 'c' chars in a string
554 **/
555
556 size_t count_chars(const char *s,char c)
557 {
558         smb_ucs2_t *ptr;
559         int count;
560         smb_ucs2_t *alloc_tmpbuf = NULL;
561
562         if (push_ucs2_allocate(&alloc_tmpbuf, s) == (size_t)-1) {
563                 return 0;
564         }
565
566         for(count=0,ptr=alloc_tmpbuf;*ptr;ptr++)
567                 if(*ptr==UCS2_CHAR(c))
568                         count++;
569
570         SAFE_FREE(alloc_tmpbuf);
571         return(count);
572 }
573
574 /**
575  Safe string copy into a known length string. maxlength does not
576  include the terminating zero.
577 **/
578
579 char *safe_strcpy_fn(const char *fn, int line, char *dest,const char *src, size_t maxlength)
580 {
581         size_t len;
582
583         if (!dest) {
584                 DEBUG(0,("ERROR: NULL dest in safe_strcpy, called from [%s][%d]\n", fn, line));
585                 return NULL;
586         }
587
588 #ifdef DEVELOPER
589         clobber_region(fn,line,dest, maxlength+1);
590 #endif
591
592         if (!src) {
593                 *dest = 0;
594                 return dest;
595         }  
596
597         len = strnlen(src, maxlength+1);
598
599         if (len > maxlength) {
600                 DEBUG(0,("ERROR: string overflow by %lu (%lu - %lu) in safe_strcpy [%.50s]\n",
601                          (unsigned long)(len-maxlength), (unsigned long)len, 
602                          (unsigned long)maxlength, src));
603                 len = maxlength;
604         }
605       
606         memmove(dest, src, len);
607         dest[len] = 0;
608         return dest;
609 }  
610
611 /**
612  Safe string cat into a string. maxlength does not
613  include the terminating zero.
614 **/
615 char *safe_strcat_fn(const char *fn, int line, char *dest, const char *src, size_t maxlength)
616 {
617         size_t src_len, dest_len;
618
619         if (!dest) {
620                 DEBUG(0,("ERROR: NULL dest in safe_strcat, called from [%s][%d]\n", fn, line));
621                 return NULL;
622         }
623
624         if (!src)
625                 return dest;
626         
627         src_len = strnlen(src, maxlength + 1);
628         dest_len = strnlen(dest, maxlength + 1);
629
630 #ifdef DEVELOPER
631         clobber_region(fn, line, dest + dest_len, maxlength + 1 - dest_len);
632 #endif
633
634         if (src_len + dest_len > maxlength) {
635                 DEBUG(0,("ERROR: string overflow by %d in safe_strcat [%.50s]\n",
636                          (int)(src_len + dest_len - maxlength), src));
637                 if (maxlength > dest_len) {
638                         memcpy(&dest[dest_len], src, maxlength - dest_len);
639                 }
640                 dest[maxlength] = 0;
641                 return NULL;
642         }
643
644         memcpy(&dest[dest_len], src, src_len);
645         dest[dest_len + src_len] = 0;
646         return dest;
647 }
648
649 /**
650  Paranoid strcpy into a buffer of given length (includes terminating
651  zero. Strips out all but 'a-Z0-9' and the character in other_safe_chars
652  and replaces with '_'. Deliberately does *NOT* check for multibyte
653  characters. Don't change it !
654 **/
655 char *alpha_strcpy_fn(const char *fn, int line, char *dest, const char *src, const char *other_safe_chars, size_t maxlength)
656 {
657         size_t len, i;
658
659 #ifdef DEVELOPER
660         clobber_region(fn, line, dest, maxlength);
661 #endif
662
663         if (!dest) {
664                 DEBUG(0,("ERROR: NULL dest in alpha_strcpy, called from [%s][%d]\n", fn, line));
665                 return NULL;
666         }
667
668         if (!src) {
669                 *dest = 0;
670                 return dest;
671         }  
672
673         len = strlen(src);
674         if (len >= maxlength)
675                 len = maxlength - 1;
676
677         if (!other_safe_chars)
678                 other_safe_chars = "";
679
680         for(i = 0; i < len; i++) {
681                 int val = (src[i] & 0xff);
682                 if (isupper(val) || islower(val) || isdigit(val) || strchr_m(other_safe_chars, val))
683                         dest[i] = src[i];
684                 else
685                         dest[i] = '_';
686         }
687
688         dest[i] = '\0';
689
690         return dest;
691 }
692
693 /**
694  Like strncpy but always null terminates. Make sure there is room!
695  The variable n should always be one less than the available size.
696 **/
697 char *StrnCpy_fn(const char *fn, int line,char *dest,const char *src,size_t n)
698 {
699         char *d = dest;
700
701 #ifdef DEVELOPER
702         clobber_region(fn, line, dest, n+1);
703 #endif
704
705         if (!dest) {
706                 DEBUG(0,("ERROR: NULL dest in StrnCpy, called from [%s][%d]\n", fn, line));
707                 return(NULL);
708         }
709
710         if (!src) {
711                 *dest = 0;
712                 return(dest);
713         }
714         
715         while (n-- && (*d = *src)) {
716                 d++;
717                 src++;
718         }
719
720         *d = 0;
721         return(dest);
722 }
723
724 #if 0
725 /**
726  Like strncpy but copies up to the character marker.  always null terminates.
727  returns a pointer to the character marker in the source string (src).
728 **/
729
730 static char *strncpyn(char *dest, const char *src, size_t n, char c)
731 {
732         char *p;
733         size_t str_len;
734
735 #ifdef DEVELOPER
736         clobber_region(dest, n+1);
737 #endif
738         p = strchr_m(src, c);
739         if (p == NULL) {
740                 DEBUG(5, ("strncpyn: separator character (%c) not found\n", c));
741                 return NULL;
742         }
743
744         str_len = PTR_DIFF(p, src);
745         strncpy(dest, src, MIN(n, str_len));
746         dest[str_len] = '\0';
747
748         return p;
749 }
750 #endif
751
752 /**
753  Routine to get hex characters and turn them into a 16 byte array.
754  the array can be variable length, and any non-hex-numeric
755  characters are skipped.  "0xnn" or "0Xnn" is specially catered
756  for.
757
758  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
759
760 **/
761
762 size_t strhex_to_str(char *p, size_t len, const char *strhex)
763 {
764         size_t i;
765         size_t num_chars = 0;
766         unsigned char   lonybble, hinybble;
767         const char     *hexchars = "0123456789ABCDEF";
768         char           *p1 = NULL, *p2 = NULL;
769
770         for (i = 0; i < len && strhex[i] != 0; i++) {
771                 if (strnequal(hexchars, "0x", 2)) {
772                         i++; /* skip two chars */
773                         continue;
774                 }
775
776                 if (!(p1 = strchr_m(hexchars, toupper(strhex[i]))))
777                         break;
778
779                 i++; /* next hex digit */
780
781                 if (!(p2 = strchr_m(hexchars, toupper(strhex[i]))))
782                         break;
783
784                 /* get the two nybbles */
785                 hinybble = PTR_DIFF(p1, hexchars);
786                 lonybble = PTR_DIFF(p2, hexchars);
787
788                 p[num_chars] = (hinybble << 4) | lonybble;
789                 num_chars++;
790
791                 p1 = NULL;
792                 p2 = NULL;
793         }
794         return num_chars;
795 }
796
797 /**
798  * Routine to print a buffer as HEX digits, into an allocated string.
799  */
800
801 void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
802 {
803         int i;
804         char *hex_buffer;
805
806         *out_hex_buffer = smb_xmalloc((len*2)+1);
807         hex_buffer = *out_hex_buffer;
808
809         for (i = 0; i < len; i++)
810                 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
811 }
812
813 /**
814  Check if a string is part of a list.
815 **/
816
817 BOOL in_list(char *s,char *list,BOOL casesensitive)
818 {
819         pstring tok;
820         const char *p=list;
821
822         if (!list)
823                 return(False);
824
825         while (next_token(&p,tok,LIST_SEP,sizeof(tok))) {
826                 if (casesensitive) {
827                         if (strcmp(tok,s) == 0)
828                                 return(True);
829                 } else {
830                         if (StrCaseCmp(tok,s) == 0)
831                                 return(True);
832                 }
833         }
834         return(False);
835 }
836
837 /* this is used to prevent lots of mallocs of size 1 */
838 static char *null_string = NULL;
839
840 /**
841  Set a string value, allocing the space for the string
842 **/
843
844 static BOOL string_init(char **dest,const char *src)
845 {
846         size_t l;
847         if (!src)     
848                 src = "";
849
850         l = strlen(src);
851
852         if (l == 0) {
853                 if (!null_string) {
854                         if((null_string = (char *)malloc(1)) == NULL) {
855                                 DEBUG(0,("string_init: malloc fail for null_string.\n"));
856                                 return False;
857                         }
858                         *null_string = 0;
859                 }
860                 *dest = null_string;
861         } else {
862                 (*dest) = strdup(src);
863                 if ((*dest) == NULL) {
864                         DEBUG(0,("Out of memory in string_init\n"));
865                         return False;
866                 }
867         }
868         return(True);
869 }
870
871 /**
872  Free a string value.
873 **/
874
875 void string_free(char **s)
876 {
877         if (!s || !(*s))
878                 return;
879         if (*s == null_string)
880                 *s = NULL;
881         SAFE_FREE(*s);
882 }
883
884 /**
885  Set a string value, deallocating any existing space, and allocing the space
886  for the string
887 **/
888
889 BOOL string_set(char **dest,const char *src)
890 {
891         string_free(dest);
892         return(string_init(dest,src));
893 }
894
895 /**
896  Substitute a string for a pattern in another string. Make sure there is 
897  enough room!
898
899  This routine looks for pattern in s and replaces it with 
900  insert. It may do multiple replacements.
901
902  Any of " ; ' $ or ` in the insert string are replaced with _
903  if len==0 then the string cannot be extended. This is different from the old
904  use of len==0 which was for no length checks to be done.
905 **/
906
907 void string_sub(char *s,const char *pattern, const char *insert, size_t len)
908 {
909         char *p;
910         ssize_t ls,lp,li, i;
911
912         if (!insert || !pattern || !*pattern || !s)
913                 return;
914
915         ls = (ssize_t)strlen(s);
916         lp = (ssize_t)strlen(pattern);
917         li = (ssize_t)strlen(insert);
918
919         if (len == 0)
920                 len = ls + 1; /* len is number of *bytes* */
921
922         while (lp <= ls && (p = strstr_m(s,pattern))) {
923                 if (ls + (li-lp) >= len) {
924                         DEBUG(0,("ERROR: string overflow by %d in string_sub(%.50s, %d)\n", 
925                                  (int)(ls + (li-lp) - len),
926                                  pattern, (int)len));
927                         break;
928                 }
929                 if (li != lp) {
930                         memmove(p+li,p+lp,strlen(p+lp)+1);
931                 }
932                 for (i=0;i<li;i++) {
933                         switch (insert[i]) {
934                         case '`':
935                         case '"':
936                         case '\'':
937                         case ';':
938                         case '$':
939                         case '%':
940                         case '\r':
941                         case '\n':
942                                 p[i] = '_';
943                                 break;
944                         default:
945                                 p[i] = insert[i];
946                         }
947                 }
948                 s = p + li;
949                 ls += (li-lp);
950         }
951 }
952
953 void fstring_sub(char *s,const char *pattern,const char *insert)
954 {
955         string_sub(s, pattern, insert, sizeof(fstring));
956 }
957
958 void pstring_sub(char *s,const char *pattern,const char *insert)
959 {
960         string_sub(s, pattern, insert, sizeof(pstring));
961 }
962
963 /**
964  Similar to string_sub, but it will accept only allocated strings
965  and may realloc them so pay attention at what you pass on no
966  pointers inside strings, no pstrings or const may be passed
967  as string.
968 **/
969
970 char *realloc_string_sub(char *string, const char *pattern, const char *insert)
971 {
972         char *p, *in;
973         char *s;
974         ssize_t ls,lp,li,ld, i;
975
976         if (!insert || !pattern || !*pattern || !string || !*string)
977                 return NULL;
978
979         s = string;
980
981         in = strdup(insert);
982         if (!in) {
983                 DEBUG(0, ("realloc_string_sub: out of memory!\n"));
984                 return NULL;
985         }
986         ls = (ssize_t)strlen(s);
987         lp = (ssize_t)strlen(pattern);
988         li = (ssize_t)strlen(insert);
989         ld = li - lp;
990         for (i=0;i<li;i++) {
991                 switch (in[i]) {
992                         case '`':
993                         case '"':
994                         case '\'':
995                         case ';':
996                         case '$':
997                         case '%':
998                         case '\r':
999                         case '\n':
1000                                 in[i] = '_';
1001                         default:
1002                                 /* ok */
1003                                 break;
1004                 }
1005         }
1006         
1007         while ((p = strstr_m(s,pattern))) {
1008                 if (ld > 0) {
1009                         int offset = PTR_DIFF(s,string);
1010                         char *t = Realloc(string, ls + ld + 1);
1011                         if (!t) {
1012                                 DEBUG(0, ("realloc_string_sub: out of memory!\n"));
1013                                 SAFE_FREE(in);
1014                                 return NULL;
1015                         }
1016                         string = t;
1017                         p = t + offset + (p - s);
1018                 }
1019                 if (li != lp) {
1020                         memmove(p+li,p+lp,strlen(p+lp)+1);
1021                 }
1022                 memcpy(p, in, li);
1023                 s = p + li;
1024                 ls += ld;
1025         }
1026         SAFE_FREE(in);
1027         return string;
1028 }
1029
1030 /**
1031  Similar to string_sub() but allows for any character to be substituted. 
1032  Use with caution!
1033  if len==0 then the string cannot be extended. This is different from the old
1034  use of len==0 which was for no length checks to be done.
1035 **/
1036
1037 void all_string_sub(char *s,const char *pattern,const char *insert, size_t len)
1038 {
1039         char *p;
1040         ssize_t ls,lp,li;
1041
1042         if (!insert || !pattern || !s)
1043                 return;
1044
1045         ls = (ssize_t)strlen(s);
1046         lp = (ssize_t)strlen(pattern);
1047         li = (ssize_t)strlen(insert);
1048
1049         if (!*pattern)
1050                 return;
1051         
1052         if (len == 0)
1053                 len = ls + 1; /* len is number of *bytes* */
1054         
1055         while (lp <= ls && (p = strstr_m(s,pattern))) {
1056                 if (ls + (li-lp) >= len) {
1057                         DEBUG(0,("ERROR: string overflow by %d in all_string_sub(%.50s, %d)\n", 
1058                                  (int)(ls + (li-lp) - len),
1059                                  pattern, (int)len));
1060                         break;
1061                 }
1062                 if (li != lp) {
1063                         memmove(p+li,p+lp,strlen(p+lp)+1);
1064                 }
1065                 memcpy(p, insert, li);
1066                 s = p + li;
1067                 ls += (li-lp);
1068         }
1069 }
1070
1071 /**
1072  Similar to all_string_sub but for unicode strings.
1073  Return a new allocated unicode string.
1074  similar to string_sub() but allows for any character to be substituted.
1075  Use with caution!
1076 **/
1077
1078 static smb_ucs2_t *all_string_sub_w(const smb_ucs2_t *s, const smb_ucs2_t *pattern,
1079                                 const smb_ucs2_t *insert)
1080 {
1081         smb_ucs2_t *r, *rp;
1082         const smb_ucs2_t *sp;
1083         size_t  lr, lp, li, lt;
1084
1085         if (!insert || !pattern || !*pattern || !s)
1086                 return NULL;
1087
1088         lt = (size_t)strlen_w(s);
1089         lp = (size_t)strlen_w(pattern);
1090         li = (size_t)strlen_w(insert);
1091
1092         if (li > lp) {
1093                 const smb_ucs2_t *st = s;
1094                 int ld = li - lp;
1095                 while ((sp = strstr_w(st, pattern))) {
1096                         st = sp + lp;
1097                         lt += ld;
1098                 }
1099         }
1100
1101         r = rp = (smb_ucs2_t *)malloc((lt + 1)*(sizeof(smb_ucs2_t)));
1102         if (!r) {
1103                 DEBUG(0, ("all_string_sub_w: out of memory!\n"));
1104                 return NULL;
1105         }
1106
1107         while ((sp = strstr_w(s, pattern))) {
1108                 memcpy(rp, s, (sp - s));
1109                 rp += ((sp - s) / sizeof(smb_ucs2_t));
1110                 memcpy(rp, insert, (li * sizeof(smb_ucs2_t)));
1111                 s = sp + lp;
1112                 rp += li;
1113         }
1114         lr = ((rp - r) / sizeof(smb_ucs2_t));
1115         if (lr < lt) {
1116                 memcpy(rp, s, ((lt - lr) * sizeof(smb_ucs2_t)));
1117                 rp += (lt - lr);
1118         }
1119         *rp = 0;
1120
1121         return r;
1122 }
1123
1124 smb_ucs2_t *all_string_sub_wa(smb_ucs2_t *s, const char *pattern,
1125                                              const char *insert)
1126 {
1127         wpstring p, i;
1128
1129         if (!insert || !pattern || !s)
1130                 return NULL;
1131         push_ucs2(NULL, p, pattern, sizeof(wpstring) - 1, STR_TERMINATE);
1132         push_ucs2(NULL, i, insert, sizeof(wpstring) - 1, STR_TERMINATE);
1133         return all_string_sub_w(s, p, i);
1134 }
1135
1136 #if 0
1137 /**
1138  Splits out the front and back at a separator.
1139 **/
1140
1141 static void split_at_last_component(char *path, char *front, char sep, char *back)
1142 {
1143         char *p = strrchr_m(path, sep);
1144
1145         if (p != NULL)
1146                 *p = 0;
1147
1148         if (front != NULL)
1149                 pstrcpy(front, path);
1150
1151         if (p != NULL) {
1152                 if (back != NULL)
1153                         pstrcpy(back, p+1);
1154                 *p = '\\';
1155         } else {
1156                 if (back != NULL)
1157                         back[0] = 0;
1158         }
1159 }
1160 #endif
1161
1162 /**
1163  Write an octal as a string.
1164 **/
1165
1166 const char *octal_string(int i)
1167 {
1168         static char ret[64];
1169         if (i == -1)
1170                 return "-1";
1171         slprintf(ret, sizeof(ret)-1, "0%o", i);
1172         return ret;
1173 }
1174
1175
1176 /**
1177  Truncate a string at a specified length.
1178 **/
1179
1180 char *string_truncate(char *s, unsigned int length)
1181 {
1182         if (s && strlen(s) > length)
1183                 s[length] = 0;
1184         return s;
1185 }
1186
1187 /**
1188  Strchr and strrchr_m are very hard to do on general multi-byte strings. 
1189  We convert via ucs2 for now.
1190 **/
1191
1192 char *strchr_m(const char *src, char c)
1193 {
1194         wpstring ws;
1195         pstring s2;
1196         smb_ucs2_t *p;
1197         const char *s;
1198
1199         /* this is quite a common operation, so we want it to be
1200            fast. We optimise for the ascii case, knowing that all our
1201            supported multi-byte character sets are ascii-compatible
1202            (ie. they match for the first 128 chars) */
1203
1204         for (s = src; *s && !(((unsigned char)s[0]) & 0x80); s++) {
1205                 if (*s == c)
1206                         return (char *)s;
1207         }
1208
1209         if (!*s)
1210                 return NULL;
1211
1212 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
1213         /* With compose characters we must restart from the beginning. JRA. */
1214         s = src;
1215 #endif
1216
1217         push_ucs2(NULL, ws, s, sizeof(ws), STR_TERMINATE);
1218         p = strchr_w(ws, UCS2_CHAR(c));
1219         if (!p)
1220                 return NULL;
1221         *p = 0;
1222         pull_ucs2_pstring(s2, ws);
1223         return (char *)(s+strlen(s2));
1224 }
1225
1226 char *strrchr_m(const char *s, char c)
1227 {
1228         /* this is quite a common operation, so we want it to be
1229            fast. We optimise for the ascii case, knowing that all our
1230            supported multi-byte character sets are ascii-compatible
1231            (ie. they match for the first 128 chars). Also, in Samba
1232            we only search for ascii characters in 'c' and that
1233            in all mb character sets with a compound character
1234            containing c, if 'c' is not a match at position
1235            p, then p[-1] > 0x7f. JRA. */
1236
1237         {
1238                 size_t len = strlen(s);
1239                 const char *cp = s;
1240                 BOOL got_mb = False;
1241
1242                 if (len == 0)
1243                         return NULL;
1244                 cp += (len - 1);
1245                 do {
1246                         if (c == *cp) {
1247                                 /* Could be a match. Part of a multibyte ? */
1248                                 if ((cp > s) && (((unsigned char)cp[-1]) & 0x80)) {
1249                                         /* Yep - go slow :-( */
1250                                         got_mb = True;
1251                                         break;
1252                                 }
1253                                 /* No - we have a match ! */
1254                                 return (char *)cp;
1255                         }
1256                 } while (cp-- != s);
1257                 if (!got_mb)
1258                         return NULL;
1259         }
1260
1261         /* String contained a non-ascii char. Slow path. */
1262         {
1263                 wpstring ws;
1264                 pstring s2;
1265                 smb_ucs2_t *p;
1266
1267                 push_ucs2(NULL, ws, s, sizeof(ws), STR_TERMINATE);
1268                 p = strrchr_w(ws, UCS2_CHAR(c));
1269                 if (!p)
1270                         return NULL;
1271                 *p = 0;
1272                 pull_ucs2_pstring(s2, ws);
1273                 return (char *)(s+strlen(s2));
1274         }
1275 }
1276
1277 /***********************************************************************
1278  Return the equivalent of doing strrchr 'n' times - always going
1279  backwards.
1280 ***********************************************************************/
1281
1282 char *strnrchr_m(const char *s, char c, unsigned int n)
1283 {
1284         wpstring ws;
1285         pstring s2;
1286         smb_ucs2_t *p;
1287
1288         push_ucs2(NULL, ws, s, sizeof(ws), STR_TERMINATE);
1289         p = strnrchr_w(ws, UCS2_CHAR(c), n);
1290         if (!p)
1291                 return NULL;
1292         *p = 0;
1293         pull_ucs2_pstring(s2, ws);
1294         return (char *)(s+strlen(s2));
1295 }
1296
1297 /***********************************************************************
1298  strstr_m - We convert via ucs2 for now.
1299 ***********************************************************************/
1300
1301 char *strstr_m(const char *src, const char *findstr)
1302 {
1303         smb_ucs2_t *p;
1304         smb_ucs2_t *src_w, *find_w;
1305         const char *s;
1306         char *s2;
1307         char *retp;
1308
1309         size_t findstr_len = 0;
1310         size_t find_w_len;
1311
1312         /* for correctness */
1313         if (!findstr[0]) {
1314                 return src;
1315         }
1316
1317         /* Samba does single character findstr calls a *lot*. */
1318         if (findstr[1] == '\0')
1319                 return strchr_m(src, *findstr);
1320
1321         /* We optimise for the ascii case, knowing that all our
1322            supported multi-byte character sets are ascii-compatible
1323            (ie. they match for the first 128 chars) */
1324
1325         for (s = src; *s && !(((unsigned char)s[0]) & 0x80); s++) {
1326                 if (*s == *findstr) {
1327                         if (!findstr_len) 
1328                                 findstr_len = strlen(findstr);
1329
1330                         if (strncmp(s, findstr, findstr_len) == 0) {
1331                                 return (char *)s;
1332                         }
1333                 }
1334         }
1335
1336         if (!*s)
1337                 return NULL;
1338
1339 #if 1 /* def BROKEN_UNICODE_COMPOSE_CHARACTERS */
1340         /* 'make check' fails unless we do this */
1341
1342         /* With compose characters we must restart from the beginning. JRA. */
1343         s = src;
1344 #endif
1345
1346         if (push_ucs2_allocate(&src_w, src) == (size_t)-1) {
1347                 DEBUG(0,("strstr_m: src malloc fail\n"));
1348                 return NULL;
1349         }
1350         
1351         if (push_ucs2_allocate(&find_w, findstr) == (size_t)-1) {
1352                 SAFE_FREE(src_w);
1353                 DEBUG(0,("strstr_m: find malloc fail\n"));
1354                 return NULL;
1355         }
1356
1357         p = strstr_w(src_w, find_w);
1358
1359         if (!p) {
1360                 SAFE_FREE(src_w);
1361                 SAFE_FREE(find_w);
1362                 return NULL;
1363         }
1364         
1365         *p = 0;
1366         if (pull_ucs2_allocate(&s2, src_w) == (size_t)-1) {
1367                 SAFE_FREE(src_w);
1368                 SAFE_FREE(find_w);
1369                 DEBUG(0,("strstr_m: dest malloc fail\n"));
1370                 return NULL;
1371         }
1372         retp = (char *)(s+strlen(s2));
1373         SAFE_FREE(src_w);
1374         SAFE_FREE(find_w);
1375         SAFE_FREE(s2);
1376         return retp;
1377 }
1378
1379 /**
1380  Convert a string to lower case.
1381 **/
1382
1383 void strlower_m(char *s)
1384 {
1385         size_t len;
1386
1387         /* this is quite a common operation, so we want it to be
1388            fast. We optimise for the ascii case, knowing that all our
1389            supported multi-byte character sets are ascii-compatible
1390            (ie. they match for the first 128 chars) */
1391
1392         while (*s && !(((unsigned char)s[0]) & 0x80)) {
1393                 *s = tolower((unsigned char)*s);
1394                 s++;
1395         }
1396
1397         if (!*s)
1398                 return;
1399
1400         /* I assume that lowercased string takes the same number of bytes
1401          * as source string even in UTF-8 encoding. (VIV) */
1402         len = strlen(s) + 1;
1403         errno = 0;
1404         unix_strlower(s,len,s,len);     
1405         /* Catch mb conversion errors that may not terminate. */
1406         if (errno)
1407                 s[len-1] = '\0';
1408 }
1409
1410 /**
1411  Convert a string to upper case.
1412 **/
1413
1414 void strupper_m(char *s)
1415 {
1416         size_t len;
1417
1418         /* this is quite a common operation, so we want it to be
1419            fast. We optimise for the ascii case, knowing that all our
1420            supported multi-byte character sets are ascii-compatible
1421            (ie. they match for the first 128 chars) */
1422
1423         while (*s && !(((unsigned char)s[0]) & 0x80)) {
1424                 *s = toupper((unsigned char)*s);
1425                 s++;
1426         }
1427
1428         if (!*s)
1429                 return;
1430
1431         /* I assume that lowercased string takes the same number of bytes
1432          * as source string even in multibyte encoding. (VIV) */
1433         len = strlen(s) + 1;
1434         errno = 0;
1435         unix_strupper(s,len,s,len);     
1436         /* Catch mb conversion errors that may not terminate. */
1437         if (errno)
1438                 s[len-1] = '\0';
1439 }
1440
1441 /**
1442  Return a RFC2254 binary string representation of a buffer.
1443  Used in LDAP filters.
1444  Caller must free.
1445 **/
1446
1447 char *binary_string(char *buf, int len)
1448 {
1449         char *s;
1450         int i, j;
1451         const char *hex = "0123456789ABCDEF";
1452         s = malloc(len * 3 + 1);
1453         if (!s)
1454                 return NULL;
1455         for (j=i=0;i<len;i++) {
1456                 s[j] = '\\';
1457                 s[j+1] = hex[((unsigned char)buf[i]) >> 4];
1458                 s[j+2] = hex[((unsigned char)buf[i]) & 0xF];
1459                 j += 3;
1460         }
1461         s[j] = 0;
1462         return s;
1463 }
1464
1465 /**
1466  Just a typesafety wrapper for snprintf into a pstring.
1467 **/
1468
1469  int pstr_sprintf(pstring s, const char *fmt, ...)
1470 {
1471         va_list ap;
1472         int ret;
1473
1474         va_start(ap, fmt);
1475         ret = vsnprintf(s, PSTRING_LEN, fmt, ap);
1476         va_end(ap);
1477         return ret;
1478 }
1479
1480
1481 /**
1482  Just a typesafety wrapper for snprintf into a fstring.
1483 **/
1484
1485 int fstr_sprintf(fstring s, const char *fmt, ...)
1486 {
1487         va_list ap;
1488         int ret;
1489
1490         va_start(ap, fmt);
1491         ret = vsnprintf(s, FSTRING_LEN, fmt, ap);
1492         va_end(ap);
1493         return ret;
1494 }
1495
1496
1497 #ifndef HAVE_STRNDUP
1498 /**
1499  Some platforms don't have strndup.
1500 **/
1501
1502  char *strndup(const char *s, size_t n)
1503 {
1504         char *ret;
1505         
1506         n = strnlen(s, n);
1507         ret = malloc(n+1);
1508         if (!ret)
1509                 return NULL;
1510         memcpy(ret, s, n);
1511         ret[n] = 0;
1512
1513         return ret;
1514 }
1515 #endif
1516
1517 #ifndef HAVE_STRNLEN
1518 /**
1519  Some platforms don't have strnlen
1520 **/
1521
1522  size_t strnlen(const char *s, size_t n)
1523 {
1524         int i;
1525         for (i=0; s[i] && i<n; i++)
1526                 /* noop */ ;
1527         return i;
1528 }
1529 #endif
1530
1531 /**
1532  List of Strings manipulation functions
1533 **/
1534
1535 #define S_LIST_ABS 16 /* List Allocation Block Size */
1536
1537 char **str_list_make(const char *string, const char *sep)
1538 {
1539         char **list, **rlist;
1540         const char *str;
1541         char *s;
1542         int num, lsize;
1543         pstring tok;
1544         
1545         if (!string || !*string)
1546                 return NULL;
1547         s = strdup(string);
1548         if (!s) {
1549                 DEBUG(0,("str_list_make: Unable to allocate memory"));
1550                 return NULL;
1551         }
1552         if (!sep) sep = LIST_SEP;
1553         
1554         num = lsize = 0;
1555         list = NULL;
1556         
1557         str = s;
1558         while (next_token(&str, tok, sep, sizeof(tok))) {               
1559                 if (num == lsize) {
1560                         lsize += S_LIST_ABS;
1561                         rlist = (char **)Realloc(list, ((sizeof(char **)) * (lsize +1)));
1562                         if (!rlist) {
1563                                 DEBUG(0,("str_list_make: Unable to allocate memory"));
1564                                 str_list_free(&list);
1565                                 SAFE_FREE(s);
1566                                 return NULL;
1567                         } else
1568                                 list = rlist;
1569                         memset (&list[num], 0, ((sizeof(char**)) * (S_LIST_ABS +1)));
1570                 }
1571                 
1572                 list[num] = strdup(tok);
1573                 if (!list[num]) {
1574                         DEBUG(0,("str_list_make: Unable to allocate memory"));
1575                         str_list_free(&list);
1576                         SAFE_FREE(s);
1577                         return NULL;
1578                 }
1579         
1580                 num++;  
1581         }
1582         
1583         SAFE_FREE(s);
1584         return list;
1585 }
1586
1587 BOOL str_list_copy(char ***dest, const char **src)
1588 {
1589         char **list, **rlist;
1590         int num, lsize;
1591         
1592         *dest = NULL;
1593         if (!src)
1594                 return False;
1595         
1596         num = lsize = 0;
1597         list = NULL;
1598                 
1599         while (src[num]) {
1600                 if (num == lsize) {
1601                         lsize += S_LIST_ABS;
1602                         rlist = (char **)Realloc(list, ((sizeof(char **)) * (lsize +1)));
1603                         if (!rlist) {
1604                                 DEBUG(0,("str_list_copy: Unable to re-allocate memory"));
1605                                 str_list_free(&list);
1606                                 return False;
1607                         } else
1608                                 list = rlist;
1609                         memset (&list[num], 0, ((sizeof(char **)) * (S_LIST_ABS +1)));
1610                 }
1611                 
1612                 list[num] = strdup(src[num]);
1613                 if (!list[num]) {
1614                         DEBUG(0,("str_list_copy: Unable to allocate memory"));
1615                         str_list_free(&list);
1616                         return False;
1617                 }
1618
1619                 num++;
1620         }
1621         
1622         *dest = list;
1623         return True;    
1624 }
1625
1626 /**
1627  * Return true if all the elements of the list match exactly.
1628  **/
1629 BOOL str_list_compare(char **list1, char **list2)
1630 {
1631         int num;
1632         
1633         if (!list1 || !list2)
1634                 return (list1 == list2); 
1635         
1636         for (num = 0; list1[num]; num++) {
1637                 if (!list2[num])
1638                         return False;
1639                 if (!strcsequal(list1[num], list2[num]))
1640                         return False;
1641         }
1642         if (list2[num])
1643                 return False; /* if list2 has more elements than list1 fail */
1644         
1645         return True;
1646 }
1647
1648 void str_list_free(char ***list)
1649 {
1650         char **tlist;
1651         
1652         if (!list || !*list)
1653                 return;
1654         tlist = *list;
1655         for(; *tlist; tlist++)
1656                 SAFE_FREE(*tlist);
1657         SAFE_FREE(*list);
1658 }
1659
1660 /******************************************************************************
1661  version of standard_sub_basic() for string lists; uses alloc_sub_basic() 
1662  for the work
1663  *****************************************************************************/
1664  
1665 BOOL str_list_sub_basic( char **list, const char *smb_name )
1666 {
1667         char *s, *tmpstr;
1668         
1669         while ( *list ) {
1670                 s = *list;
1671                 tmpstr = alloc_sub_basic(smb_name, s);
1672                 if ( !tmpstr ) {
1673                         DEBUG(0,("str_list_sub_basic: alloc_sub_basic() return NULL!\n"));
1674                         return False;
1675                 }
1676
1677                 *list = tmpstr;
1678                         
1679                 list++;
1680         }
1681
1682         return True;
1683 }
1684
1685 /******************************************************************************
1686  substritute a specific pattern in a string list
1687  *****************************************************************************/
1688  
1689 BOOL str_list_substitute(char **list, const char *pattern, const char *insert)
1690 {
1691         char *p, *s, *t;
1692         ssize_t ls, lp, li, ld, i, d;
1693
1694         if (!list)
1695                 return False;
1696         if (!pattern)
1697                 return False;
1698         if (!insert)
1699                 return False;
1700
1701         lp = (ssize_t)strlen(pattern);
1702         li = (ssize_t)strlen(insert);
1703         ld = li -lp;
1704                         
1705         while (*list) {
1706                 s = *list;
1707                 ls = (ssize_t)strlen(s);
1708
1709                 while ((p = strstr_m(s, pattern))) {
1710                         t = *list;
1711                         d = p -t;
1712                         if (ld) {
1713                                 t = (char *) malloc(ls +ld +1);
1714                                 if (!t) {
1715                                         DEBUG(0,("str_list_substitute: Unable to allocate memory"));
1716                                         return False;
1717                                 }
1718                                 memcpy(t, *list, d);
1719                                 memcpy(t +d +li, p +lp, ls -d -lp +1);
1720                                 SAFE_FREE(*list);
1721                                 *list = t;
1722                                 ls += ld;
1723                                 s = t +d +li;
1724                         }
1725                         
1726                         for (i = 0; i < li; i++) {
1727                                 switch (insert[i]) {
1728                                         case '`':
1729                                         case '"':
1730                                         case '\'':
1731                                         case ';':
1732                                         case '$':
1733                                         case '%':
1734                                         case '\r':
1735                                         case '\n':
1736                                                 t[d +i] = '_';
1737                                                 break;
1738                                         default:
1739                                                 t[d +i] = insert[i];
1740                                 }
1741                         }       
1742                 }
1743                 
1744                 
1745                 list++;
1746         }
1747         
1748         return True;
1749 }
1750
1751
1752 #define IPSTR_LIST_SEP  ","
1753 #define IPSTR_LIST_CHAR ','
1754
1755 /**
1756  * Add ip string representation to ipstr list. Used also
1757  * as part of @function ipstr_list_make
1758  *
1759  * @param ipstr_list pointer to string containing ip list;
1760  *        MUST BE already allocated and IS reallocated if necessary
1761  * @param ipstr_size pointer to current size of ipstr_list (might be changed
1762  *        as a result of reallocation)
1763  * @param ip IP address which is to be added to list
1764  * @return pointer to string appended with new ip and possibly
1765  *         reallocated to new length
1766  **/
1767
1768 char* ipstr_list_add(char** ipstr_list, const struct ip_service *service)
1769 {
1770         char* new_ipstr = NULL;
1771         
1772         /* arguments checking */
1773         if (!ipstr_list || !service) return NULL;
1774
1775         /* attempt to convert ip to a string and append colon separator to it */
1776         if (*ipstr_list) {
1777                 asprintf(&new_ipstr, "%s%s%s:%d", *ipstr_list, IPSTR_LIST_SEP,
1778                         inet_ntoa(service->ip), service->port);
1779                 SAFE_FREE(*ipstr_list);
1780         } else {
1781                 asprintf(&new_ipstr, "%s:%d", inet_ntoa(service->ip), service->port);
1782         }
1783         *ipstr_list = new_ipstr;
1784         return *ipstr_list;
1785 }
1786
1787
1788 /**
1789  * Allocate and initialise an ipstr list using ip adresses
1790  * passed as arguments.
1791  *
1792  * @param ipstr_list pointer to string meant to be allocated and set
1793  * @param ip_list array of ip addresses to place in the list
1794  * @param ip_count number of addresses stored in ip_list
1795  * @return pointer to allocated ip string
1796  **/
1797  
1798 char* ipstr_list_make(char** ipstr_list, const struct ip_service* ip_list, int ip_count)
1799 {
1800         int i;
1801         
1802         /* arguments checking */
1803         if (!ip_list && !ipstr_list) return 0;
1804
1805         *ipstr_list = NULL;
1806         
1807         /* process ip addresses given as arguments */
1808         for (i = 0; i < ip_count; i++)
1809                 *ipstr_list = ipstr_list_add(ipstr_list, &ip_list[i]);
1810         
1811         return (*ipstr_list);
1812 }
1813
1814
1815 /**
1816  * Parse given ip string list into array of ip addresses
1817  * (as ip_service structures)  
1818  *    e.g. 192.168.1.100:389,192.168.1.78, ...
1819  *
1820  * @param ipstr ip string list to be parsed 
1821  * @param ip_list pointer to array of ip addresses which is
1822  *        allocated by this function and must be freed by caller
1823  * @return number of succesfully parsed addresses
1824  **/
1825  
1826 int ipstr_list_parse(const char* ipstr_list, struct ip_service **ip_list)
1827 {
1828         fstring token_str;
1829         size_t count;
1830         int i;
1831
1832         if (!ipstr_list || !ip_list) 
1833                 return 0;
1834         
1835         count = count_chars(ipstr_list, IPSTR_LIST_CHAR) + 1;
1836         if ( (*ip_list = (struct ip_service*)malloc(count * sizeof(struct ip_service))) == NULL ) {
1837                 DEBUG(0,("ipstr_list_parse: malloc failed for %lu entries\n", (unsigned long)count));
1838                 return 0;
1839         }
1840         
1841         for ( i=0; 
1842                 next_token(&ipstr_list, token_str, IPSTR_LIST_SEP, FSTRING_LEN) && i<count; 
1843                 i++ ) 
1844         {
1845                 struct in_addr addr;
1846                 unsigned port = 0;      
1847                 char *p = strchr(token_str, ':');
1848                 
1849                 if (p) {
1850                         *p = 0;
1851                         port = atoi(p+1);
1852                 }
1853
1854                 /* convert single token to ip address */
1855                 if ( (addr.s_addr = inet_addr(token_str)) == INADDR_NONE )
1856                         break;
1857                                 
1858                 (*ip_list)[i].ip = addr;
1859                 (*ip_list)[i].port = port;
1860         }
1861         
1862         return count;
1863 }
1864
1865
1866 /**
1867  * Safely free ip string list
1868  *
1869  * @param ipstr_list ip string list to be freed
1870  **/
1871
1872 void ipstr_list_free(char* ipstr_list)
1873 {
1874         SAFE_FREE(ipstr_list);
1875 }
1876
1877
1878 /**
1879  Unescape a URL encoded string, in place.
1880 **/
1881
1882 void rfc1738_unescape(char *buf)
1883 {
1884         char *p=buf;
1885
1886         while (p && *p && (p=strchr_m(p,'%'))) {
1887                 int c1 = p[1];
1888                 int c2 = p[2];
1889
1890                 if (c1 >= '0' && c1 <= '9')
1891                         c1 = c1 - '0';
1892                 else if (c1 >= 'A' && c1 <= 'F')
1893                         c1 = 10 + c1 - 'A';
1894                 else if (c1 >= 'a' && c1 <= 'f')
1895                         c1 = 10 + c1 - 'a';
1896                 else {p++; continue;}
1897
1898                 if (c2 >= '0' && c2 <= '9')
1899                         c2 = c2 - '0';
1900                 else if (c2 >= 'A' && c2 <= 'F')
1901                         c2 = 10 + c2 - 'A';
1902                 else if (c2 >= 'a' && c2 <= 'f')
1903                         c2 = 10 + c2 - 'a';
1904                 else {p++; continue;}
1905                         
1906                 *p = (c1<<4) | c2;
1907
1908                 memmove(p+1, p+3, strlen(p+3)+1);
1909                 p++;
1910         }
1911 }
1912
1913 static const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
1914
1915 /**
1916  * Decode a base64 string into a DATA_BLOB - simple and slow algorithm
1917  **/
1918 DATA_BLOB base64_decode_data_blob(const char *s)
1919 {
1920         int bit_offset, byte_offset, idx, i, n;
1921         DATA_BLOB decoded = data_blob(s, strlen(s)+1);
1922         unsigned char *d = decoded.data;
1923         char *p;
1924
1925         n=i=0;
1926
1927         while (*s && (p=strchr_m(b64,*s))) {
1928                 idx = (int)(p - b64);
1929                 byte_offset = (i*6)/8;
1930                 bit_offset = (i*6)%8;
1931                 d[byte_offset] &= ~((1<<(8-bit_offset))-1);
1932                 if (bit_offset < 3) {
1933                         d[byte_offset] |= (idx << (2-bit_offset));
1934                         n = byte_offset+1;
1935                 } else {
1936                         d[byte_offset] |= (idx >> (bit_offset-2));
1937                         d[byte_offset+1] = 0;
1938                         d[byte_offset+1] |= (idx << (8-(bit_offset-2))) & 0xFF;
1939                         n = byte_offset+2;
1940                 }
1941                 s++; i++;
1942         }
1943
1944         if (*s == '=') n -= 1;
1945
1946         /* fix up length */
1947         decoded.length = n;
1948         return decoded;
1949 }
1950
1951 /**
1952  * Decode a base64 string in-place - wrapper for the above
1953  **/
1954 void base64_decode_inplace(char *s)
1955 {
1956         DATA_BLOB decoded = base64_decode_data_blob(s);
1957         memcpy(s, decoded.data, decoded.length);
1958         /* null terminate */
1959         s[decoded.length] = '\0';
1960
1961         data_blob_free(&decoded);
1962 }
1963
1964 /**
1965  * Encode a base64 string into a malloc()ed string caller to free.
1966  *
1967  *From SQUID: adopted from http://ftp.sunet.se/pub2/gnu/vm/base64-encode.c with adjustments
1968  **/
1969 char * base64_encode_data_blob(DATA_BLOB data)
1970 {
1971         int bits = 0;
1972         int char_count = 0;
1973         size_t out_cnt = 0;
1974         size_t len = data.length;
1975         size_t output_len = data.length * 2;
1976         char *result = malloc(output_len); /* get us plenty of space */
1977
1978         while (len-- && out_cnt < (data.length * 2) - 5) {
1979                 int c = (unsigned char) *(data.data++);
1980                 bits += c;
1981                 char_count++;
1982                 if (char_count == 3) {
1983                         result[out_cnt++] = b64[bits >> 18];
1984                         result[out_cnt++] = b64[(bits >> 12) & 0x3f];
1985                         result[out_cnt++] = b64[(bits >> 6) & 0x3f];
1986             result[out_cnt++] = b64[bits & 0x3f];
1987             bits = 0;
1988             char_count = 0;
1989         } else {
1990             bits <<= 8;
1991         }
1992     }
1993     if (char_count != 0) {
1994         bits <<= 16 - (8 * char_count);
1995         result[out_cnt++] = b64[bits >> 18];
1996         result[out_cnt++] = b64[(bits >> 12) & 0x3f];
1997         if (char_count == 1) {
1998             result[out_cnt++] = '=';
1999             result[out_cnt++] = '=';
2000         } else {
2001             result[out_cnt++] = b64[(bits >> 6) & 0x3f];
2002             result[out_cnt++] = '=';
2003         }
2004     }
2005     result[out_cnt] = '\0';     /* terminate */
2006     return result;
2007 }
2008
2009 /* read a SMB_BIG_UINT from a string */
2010 SMB_BIG_UINT STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr)
2011 {
2012
2013         SMB_BIG_UINT val = -1;
2014         const char *p = nptr;
2015         
2016         while (p && *p && isspace(*p))
2017                 p++;
2018 #ifdef LARGE_SMB_OFF_T
2019         sscanf(p,"%llu",&val);  
2020 #else /* LARGE_SMB_OFF_T */
2021         sscanf(p,"%lu",&val);
2022 #endif /* LARGE_SMB_OFF_T */
2023         if (entptr) {
2024                 while (p && *p && isdigit(*p))
2025                         p++;
2026                 *entptr = p;
2027         }
2028
2029         return val;
2030 }