r25014: Use talloc for allocating values as well.
[kai/samba.git] / source4 / lib / util / 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    Copyright (C) James Peach     2005
9    
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14    
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19    
20    You should have received a copy of the GNU General Public License
21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
22 */
23
24 #include "includes.h"
25 #include "libcli/raw/smb.h"
26 #include "system/locale.h"
27
28 /**
29  * @file
30  * @brief String utilities.
31  **/
32
33
34 /**
35  Trim the specified elements off the front and back of a string.
36 **/
37 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
38 {
39         bool ret = false;
40         size_t front_len;
41         size_t back_len;
42         size_t len;
43
44         /* Ignore null or empty strings. */
45         if (!s || (s[0] == '\0'))
46                 return false;
47
48         front_len       = front? strlen(front) : 0;
49         back_len        = back? strlen(back) : 0;
50
51         len = strlen(s);
52
53         if (front_len) {
54                 while (len && strncmp(s, front, front_len)==0) {
55                         /* Must use memmove here as src & dest can
56                          * easily overlap. Found by valgrind. JRA. */
57                         memmove(s, s+front_len, (len-front_len)+1);
58                         len -= front_len;
59                         ret=true;
60                 }
61         }
62         
63         if (back_len) {
64                 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
65                         s[len-back_len]='\0';
66                         len -= back_len;
67                         ret=true;
68                 }
69         }
70         return ret;
71 }
72
73 /**
74  Find the number of 'c' chars in a string
75 **/
76 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
77 {
78         size_t count = 0;
79
80         while (*s) {
81                 if (*s == c) count++;
82                 s ++;
83         }
84
85         return count;
86 }
87
88
89
90 /**
91  Safe string copy into a known length string. maxlength does not
92  include the terminating zero.
93 **/
94 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength)
95 {
96         size_t len;
97
98         if (!dest) {
99                 DEBUG(0,("ERROR: NULL dest in safe_strcpy\n"));
100                 return NULL;
101         }
102
103 #ifdef DEVELOPER
104         /* We intentionally write out at the extremity of the destination
105          * string.  If the destination is too short (e.g. pstrcpy into mallocd
106          * or fstring) then this should cause an error under a memory
107          * checker. */
108         dest[maxlength] = '\0';
109         if (PTR_DIFF(&len, dest) > 0) {  /* check if destination is on the stack, ok if so */
110                 log_suspicious_usage("safe_strcpy", src);
111         }
112 #endif
113
114         if (!src) {
115                 *dest = 0;
116                 return dest;
117         }  
118
119         len = strlen(src);
120
121         if (len > maxlength) {
122                 DEBUG(0,("ERROR: string overflow by %u (%u - %u) in safe_strcpy [%.50s]\n",
123                          (uint_t)(len-maxlength), (unsigned)len, (unsigned)maxlength, src));
124                 len = maxlength;
125         }
126       
127         memmove(dest, src, len);
128         dest[len] = 0;
129         return dest;
130 }  
131
132 /**
133  Safe string cat into a string. maxlength does not
134  include the terminating zero.
135 **/
136 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength)
137 {
138         size_t src_len, dest_len;
139
140         if (!dest) {
141                 DEBUG(0,("ERROR: NULL dest in safe_strcat\n"));
142                 return NULL;
143         }
144
145         if (!src)
146                 return dest;
147         
148 #ifdef DEVELOPER
149         if (PTR_DIFF(&src_len, dest) > 0) {  /* check if destination is on the stack, ok if so */
150                 log_suspicious_usage("safe_strcat", src);
151         }
152 #endif
153         src_len = strlen(src);
154         dest_len = strlen(dest);
155
156         if (src_len + dest_len > maxlength) {
157                 DEBUG(0,("ERROR: string overflow by %d in safe_strcat [%.50s]\n",
158                          (int)(src_len + dest_len - maxlength), src));
159                 if (maxlength > dest_len) {
160                         memcpy(&dest[dest_len], src, maxlength - dest_len);
161                 }
162                 dest[maxlength] = 0;
163                 return NULL;
164         }
165         
166         memcpy(&dest[dest_len], src, src_len);
167         dest[dest_len + src_len] = 0;
168         return dest;
169 }
170
171 /**
172  Routine to get hex characters and turn them into a 16 byte array.
173  the array can be variable length, and any non-hex-numeric
174  characters are skipped.  "0xnn" or "0Xnn" is specially catered
175  for.
176
177  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
178
179
180 **/
181 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex)
182 {
183         size_t i;
184         size_t num_chars = 0;
185         uint8_t   lonybble, hinybble;
186         const char     *hexchars = "0123456789ABCDEF";
187         char           *p1 = NULL, *p2 = NULL;
188
189         for (i = 0; i < len && strhex[i] != 0; i++) {
190                 if (strncasecmp(hexchars, "0x", 2) == 0) {
191                         i++; /* skip two chars */
192                         continue;
193                 }
194
195                 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
196                         break;
197
198                 i++; /* next hex digit */
199
200                 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
201                         break;
202
203                 /* get the two nybbles */
204                 hinybble = PTR_DIFF(p1, hexchars);
205                 lonybble = PTR_DIFF(p2, hexchars);
206
207                 p[num_chars] = (hinybble << 4) | lonybble;
208                 num_chars++;
209
210                 p1 = NULL;
211                 p2 = NULL;
212         }
213         return num_chars;
214 }
215
216 /** 
217  * Parse a hex string and return a data blob. 
218  */
219 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(const char *strhex) 
220 {
221         DATA_BLOB ret_blob = data_blob(NULL, strlen(strhex)/2+1);
222
223         ret_blob.length = strhex_to_str((char *)ret_blob.data,  
224                                         strlen(strhex), 
225                                         strhex);
226
227         return ret_blob;
228 }
229
230
231 /**
232  * Routine to print a buffer as HEX digits, into an allocated string.
233  */
234 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
235 {
236         int i;
237         char *hex_buffer;
238
239         *out_hex_buffer = malloc_array_p(char, (len*2)+1);
240         hex_buffer = *out_hex_buffer;
241
242         for (i = 0; i < len; i++)
243                 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
244 }
245
246 /**
247  * talloc version of hex_encode()
248  */
249 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
250 {
251         int i;
252         char *hex_buffer;
253
254         hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
255
256         for (i = 0; i < len; i++)
257                 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
258
259         return hex_buffer;
260 }
261
262 /**
263  Set a string value, deallocating any existing space, and allocing the space
264  for the string
265 **/
266 _PUBLIC_ bool string_set(TALLOC_CTX *mem_ctx, char **dest, const char *src)
267 {
268         talloc_free(*dest);
269
270         if (src == NULL) 
271                 src = "";
272
273         *dest = talloc_strdup(mem_ctx, src);
274         if ((*dest) == NULL) {
275                 DEBUG(0,("Out of memory in string_init\n"));
276                 return false;
277         }
278
279         return true;
280 }
281
282 /**
283  Substitute a string for a pattern in another string. Make sure there is 
284  enough room!
285
286  This routine looks for pattern in s and replaces it with 
287  insert. It may do multiple replacements.
288
289  Any of " ; ' $ or ` in the insert string are replaced with _
290  if len==0 then the string cannot be extended. This is different from the old
291  use of len==0 which was for no length checks to be done.
292 **/
293
294 _PUBLIC_ void string_sub(char *s, const char *pattern, const char *insert, size_t len)
295 {
296         char *p;
297         ssize_t ls,lp,li, i;
298
299         if (!insert || !pattern || !*pattern || !s)
300                 return;
301
302         ls = (ssize_t)strlen(s);
303         lp = (ssize_t)strlen(pattern);
304         li = (ssize_t)strlen(insert);
305
306         if (len == 0)
307                 len = ls + 1; /* len is number of *bytes* */
308
309         while (lp <= ls && (p = strstr(s,pattern))) {
310                 if (ls + (li-lp) >= len) {
311                         DEBUG(0,("ERROR: string overflow by %d in string_sub(%.50s, %d)\n", 
312                                  (int)(ls + (li-lp) - len),
313                                  pattern, (int)len));
314                         break;
315                 }
316                 if (li != lp) {
317                         memmove(p+li,p+lp,strlen(p+lp)+1);
318                 }
319                 for (i=0;i<li;i++) {
320                         switch (insert[i]) {
321                         case '`':
322                         case '"':
323                         case '\'':
324                         case ';':
325                         case '$':
326                         case '%':
327                         case '\r':
328                         case '\n':
329                                 p[i] = '_';
330                                 break;
331                         default:
332                                 p[i] = insert[i];
333                         }
334                 }
335                 s = p + li;
336                 ls += (li-lp);
337         }
338 }
339
340
341 /**
342  Similar to string_sub() but allows for any character to be substituted. 
343  Use with caution!
344  if len==0 then the string cannot be extended. This is different from the old
345  use of len==0 which was for no length checks to be done.
346 **/
347
348 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len)
349 {
350         char *p;
351         ssize_t ls,lp,li;
352
353         if (!insert || !pattern || !s)
354                 return;
355
356         ls = (ssize_t)strlen(s);
357         lp = (ssize_t)strlen(pattern);
358         li = (ssize_t)strlen(insert);
359
360         if (!*pattern)
361                 return;
362         
363         if (len == 0)
364                 len = ls + 1; /* len is number of *bytes* */
365         
366         while (lp <= ls && (p = strstr(s,pattern))) {
367                 if (ls + (li-lp) >= len) {
368                         DEBUG(0,("ERROR: string overflow by %d in all_string_sub(%.50s, %d)\n", 
369                                  (int)(ls + (li-lp) - len),
370                                  pattern, (int)len));
371                         break;
372                 }
373                 if (li != lp) {
374                         memmove(p+li,p+lp,strlen(p+lp)+1);
375                 }
376                 memcpy(p, insert, li);
377                 s = p + li;
378                 ls += (li-lp);
379         }
380 }
381
382
383
384 /**
385  Unescape a URL encoded string, in place.
386 **/
387
388 _PUBLIC_ void rfc1738_unescape(char *buf)
389 {
390         char *p=buf;
391
392         while ((p=strchr(p,'+')))
393                 *p = ' ';
394
395         p = buf;
396
397         while (p && *p && (p=strchr(p,'%'))) {
398                 int c1 = p[1];
399                 int c2 = p[2];
400
401                 if (c1 >= '0' && c1 <= '9')
402                         c1 = c1 - '0';
403                 else if (c1 >= 'A' && c1 <= 'F')
404                         c1 = 10 + c1 - 'A';
405                 else if (c1 >= 'a' && c1 <= 'f')
406                         c1 = 10 + c1 - 'a';
407                 else {p++; continue;}
408
409                 if (c2 >= '0' && c2 <= '9')
410                         c2 = c2 - '0';
411                 else if (c2 >= 'A' && c2 <= 'F')
412                         c2 = 10 + c2 - 'A';
413                 else if (c2 >= 'a' && c2 <= 'f')
414                         c2 = 10 + c2 - 'a';
415                 else {p++; continue;}
416                         
417                 *p = (c1<<4) | c2;
418
419                 memmove(p+1, p+3, strlen(p+3)+1);
420                 p++;
421         }
422 }
423
424 #ifdef VALGRIND
425 size_t valgrind_strlen(const char *s)
426 {
427         size_t count;
428         for(count = 0; *s++; count++)
429                 ;
430         return count;
431 }
432 #endif
433
434
435 /**
436   format a string into length-prefixed dotted domain format, as used in NBT
437   and in some ADS structures
438 **/
439 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s)
440 {
441         char *ret;
442         int i;
443         if (!s || !*s) {
444                 return talloc_strdup(mem_ctx, "");
445         }
446         ret = talloc_array(mem_ctx, char, strlen(s)+2);
447         if (!ret) {
448                 return ret;
449         }
450         
451         memcpy(ret+1, s, strlen(s)+1);
452         ret[0] = '.';
453
454         for (i=0;ret[i];i++) {
455                 if (ret[i] == '.') {
456                         char *p = strchr(ret+i+1, '.');
457                         if (p) {
458                                 ret[i] = p-(ret+i+1);
459                         } else {
460                                 ret[i] = strlen(ret+i+1);
461                         }
462                 }
463         }
464
465         return ret;
466 }
467
468 /**
469  * Add a string to an array of strings.
470  *
471  * num should be a pointer to an integer that holds the current 
472  * number of elements in strings. It will be updated by this function.
473  */
474 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
475                          const char *str, const char ***strings, int *num)
476 {
477         char *dup_str = talloc_strdup(mem_ctx, str);
478
479         *strings = talloc_realloc(mem_ctx,
480                                     *strings,
481                                     const char *, ((*num)+1));
482
483         if ((*strings == NULL) || (dup_str == NULL))
484                 return false;
485
486         (*strings)[*num] = dup_str;
487         *num += 1;
488
489         return true;
490 }
491
492
493
494 /**
495   varient of strcmp() that handles NULL ptrs
496 **/
497 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
498 {
499         if (s1 == s2) {
500                 return 0;
501         }
502         if (s1 == NULL || s2 == NULL) {
503                 return s1?-1:1;
504         }
505         return strcmp(s1, s2);
506 }
507
508
509 /**
510 return the number of bytes occupied by a buffer in ASCII format
511 the result includes the null termination
512 limited by 'n' bytes
513 **/
514 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
515 {
516         size_t len;
517
518         len = strnlen(src, n);
519         if (len+1 <= n) {
520                 len += 1;
521         }
522
523         return len;
524 }
525
526
527 /**
528  Return a string representing a CIFS attribute for a file.
529 **/
530 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib)
531 {
532         int i, len;
533         const struct {
534                 char c;
535                 uint16_t attr;
536         } attr_strs[] = {
537                 {'V', FILE_ATTRIBUTE_VOLUME},
538                 {'D', FILE_ATTRIBUTE_DIRECTORY},
539                 {'A', FILE_ATTRIBUTE_ARCHIVE},
540                 {'H', FILE_ATTRIBUTE_HIDDEN},
541                 {'S', FILE_ATTRIBUTE_SYSTEM},
542                 {'N', FILE_ATTRIBUTE_NORMAL},
543                 {'R', FILE_ATTRIBUTE_READONLY},
544                 {'d', FILE_ATTRIBUTE_DEVICE},
545                 {'t', FILE_ATTRIBUTE_TEMPORARY},
546                 {'s', FILE_ATTRIBUTE_SPARSE},
547                 {'r', FILE_ATTRIBUTE_REPARSE_POINT},
548                 {'c', FILE_ATTRIBUTE_COMPRESSED},
549                 {'o', FILE_ATTRIBUTE_OFFLINE},
550                 {'n', FILE_ATTRIBUTE_NONINDEXED},
551                 {'e', FILE_ATTRIBUTE_ENCRYPTED}
552         };
553         char *ret;
554
555         ret = talloc_array(mem_ctx, char, ARRAY_SIZE(attr_strs)+1);
556         if (!ret) {
557                 return NULL;
558         }
559
560         for (len=i=0; i<ARRAY_SIZE(attr_strs); i++) {
561                 if (attrib & attr_strs[i].attr) {
562                         ret[len++] = attr_strs[i].c;
563                 }
564         }
565
566         ret[len] = 0;
567
568         return ret;
569 }
570
571 /**
572  Set a boolean variable from the text value stored in the passed string.
573  Returns true in success, false if the passed string does not correctly 
574  represent a boolean.
575 **/
576
577 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
578 {
579         if (strwicmp(boolean_string, "yes") == 0 ||
580             strwicmp(boolean_string, "true") == 0 ||
581             strwicmp(boolean_string, "on") == 0 ||
582             strwicmp(boolean_string, "1") == 0) {
583                 *boolean = true;
584                 return true;
585         } else if (strwicmp(boolean_string, "no") == 0 ||
586                    strwicmp(boolean_string, "false") == 0 ||
587                    strwicmp(boolean_string, "off") == 0 ||
588                    strwicmp(boolean_string, "0") == 0) {
589                 *boolean = false;
590                 return true;
591         }
592         return false;
593 }
594
595 /**
596  * Parse a string containing a boolean value.
597  *
598  * val will be set to the read value.
599  *
600  * @retval true if a boolean value was parsed, false otherwise.
601  */
602 _PUBLIC_ bool conv_str_bool(const char * str, bool * val)
603 {
604         char *  end = NULL;
605         long    lval;
606
607         if (str == NULL || *str == '\0') {
608                 return false;
609         }
610
611         lval = strtol(str, &end, 10 /* base */);
612         if (end == NULL || *end != '\0' || end == str) {
613                 return set_boolean(str, val);
614         }
615
616         *val = (lval) ? true : false;
617         return true;
618 }
619
620 /**
621  * Convert a size specification like 16K into an integral number of bytes. 
622  **/
623 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val)
624 {
625         char *              end = NULL;
626         unsigned long long  lval;
627
628         if (str == NULL || *str == '\0') {
629                 return false;
630         }
631
632         lval = strtoull(str, &end, 10 /* base */);
633         if (end == NULL || end == str) {
634                 return false;
635         }
636
637         if (*end) {
638                 if (strwicmp(end, "K") == 0) {
639                         lval *= 1024ULL;
640                 } else if (strwicmp(end, "M") == 0) {
641                         lval *= (1024ULL * 1024ULL);
642                 } else if (strwicmp(end, "G") == 0) {
643                         lval *= (1024ULL * 1024ULL * 1024ULL);
644                 } else if (strwicmp(end, "T") == 0) {
645                         lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL);
646                 } else if (strwicmp(end, "P") == 0) {
647                         lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL * 1024ULL);
648                 } else {
649                         return false;
650                 }
651         }
652
653         *val = (uint64_t)lval;
654         return true;
655 }
656
657 /**
658  * Parse a uint64_t value from a string
659  *
660  * val will be set to the value read.
661  *
662  * @retval true if parsing was successful, false otherwise
663  */
664 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val)
665 {
666         char *              end = NULL;
667         unsigned long long  lval;
668
669         if (str == NULL || *str == '\0') {
670                 return false;
671         }
672
673         lval = strtoull(str, &end, 10 /* base */);
674         if (end == NULL || *end != '\0' || end == str) {
675                 return false;
676         }
677
678         *val = (uint64_t)lval;
679         return true;
680 }
681
682 /**
683 return the number of bytes occupied by a buffer in CH_UTF16 format
684 the result includes the null termination
685 **/
686 _PUBLIC_ size_t utf16_len(const void *buf)
687 {
688         size_t len;
689
690         for (len = 0; SVAL(buf,len); len += 2) ;
691
692         return len + 2;
693 }
694
695 /**
696 return the number of bytes occupied by a buffer in CH_UTF16 format
697 the result includes the null termination
698 limited by 'n' bytes
699 **/
700 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
701 {
702         size_t len;
703
704         for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
705
706         if (len+2 <= n) {
707                 len += 2;
708         }
709
710         return len;
711 }
712
713 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags)
714 {
715         if (flags & (STR_NOALIGN|STR_ASCII))
716                 return 0;
717         return PTR_DIFF(p, base_ptr) & 1;
718 }
719
720 /**
721 Do a case-insensitive, whitespace-ignoring string compare.
722 **/
723 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2)
724 {
725         /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
726         /* appropriate value. */
727         if (psz1 == psz2)
728                 return (0);
729         else if (psz1 == NULL)
730                 return (-1);
731         else if (psz2 == NULL)
732                 return (1);
733
734         /* sync the strings on first non-whitespace */
735         while (1) {
736                 while (isspace((int)*psz1))
737                         psz1++;
738                 while (isspace((int)*psz2))
739                         psz2++;
740                 if (toupper((unsigned char)*psz1) != toupper((unsigned char)*psz2) 
741                     || *psz1 == '\0'
742                     || *psz2 == '\0')
743                         break;
744                 psz1++;
745                 psz2++;
746         }
747         return (*psz1 - *psz2);
748 }
749
750 /**
751  String replace.
752 **/
753 _PUBLIC_ void string_replace(char *s, char oldc, char newc)
754 {
755         while (*s) {
756                 if (*s == oldc) *s = newc;
757                 s++;
758         }
759 }
760
761 /**
762  * Compare 2 strings.
763  *
764  * @note The comparison is case-insensitive.
765  **/
766 _PUBLIC_ bool strequal(const char *s1, const char *s2)
767 {
768         if (s1 == s2)
769                 return true;
770         if (!s1 || !s2)
771                 return false;
772   
773         return strcasecmp(s1,s2) == 0;
774 }