Merge branch 'master' of ssh://git.samba.org/data/git/samba
[samba.git] / 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(TALLOC_CTX *mem_ctx, const char *strhex) 
220 {
221         DATA_BLOB ret_blob = data_blob(mem_ctx, 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  Unescape a URL encoded string, in place.
264 **/
265
266 _PUBLIC_ void rfc1738_unescape(char *buf)
267 {
268         char *p=buf;
269
270         while ((p=strchr(p,'+')))
271                 *p = ' ';
272
273         p = buf;
274
275         while (p && *p && (p=strchr(p,'%'))) {
276                 int c1 = p[1];
277                 int c2 = p[2];
278
279                 if (c1 >= '0' && c1 <= '9')
280                         c1 = c1 - '0';
281                 else if (c1 >= 'A' && c1 <= 'F')
282                         c1 = 10 + c1 - 'A';
283                 else if (c1 >= 'a' && c1 <= 'f')
284                         c1 = 10 + c1 - 'a';
285                 else {p++; continue;}
286
287                 if (c2 >= '0' && c2 <= '9')
288                         c2 = c2 - '0';
289                 else if (c2 >= 'A' && c2 <= 'F')
290                         c2 = 10 + c2 - 'A';
291                 else if (c2 >= 'a' && c2 <= 'f')
292                         c2 = 10 + c2 - 'a';
293                 else {p++; continue;}
294                         
295                 *p = (c1<<4) | c2;
296
297                 memmove(p+1, p+3, strlen(p+3)+1);
298                 p++;
299         }
300 }
301
302 #ifdef VALGRIND
303 size_t valgrind_strlen(const char *s)
304 {
305         size_t count;
306         for(count = 0; *s++; count++)
307                 ;
308         return count;
309 }
310 #endif
311
312
313 /**
314   format a string into length-prefixed dotted domain format, as used in NBT
315   and in some ADS structures
316 **/
317 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s)
318 {
319         char *ret;
320         int i;
321         if (!s || !*s) {
322                 return talloc_strdup(mem_ctx, "");
323         }
324         ret = talloc_array(mem_ctx, char, strlen(s)+2);
325         if (!ret) {
326                 return ret;
327         }
328         
329         memcpy(ret+1, s, strlen(s)+1);
330         ret[0] = '.';
331
332         for (i=0;ret[i];i++) {
333                 if (ret[i] == '.') {
334                         char *p = strchr(ret+i+1, '.');
335                         if (p) {
336                                 ret[i] = p-(ret+i+1);
337                         } else {
338                                 ret[i] = strlen(ret+i+1);
339                         }
340                 }
341         }
342
343         return ret;
344 }
345
346 /**
347  * Add a string to an array of strings.
348  *
349  * num should be a pointer to an integer that holds the current 
350  * number of elements in strings. It will be updated by this function.
351  */
352 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
353                          const char *str, const char ***strings, int *num)
354 {
355         char *dup_str = talloc_strdup(mem_ctx, str);
356
357         *strings = talloc_realloc(mem_ctx,
358                                     *strings,
359                                     const char *, ((*num)+1));
360
361         if ((*strings == NULL) || (dup_str == NULL))
362                 return false;
363
364         (*strings)[*num] = dup_str;
365         *num += 1;
366
367         return true;
368 }
369
370
371
372 /**
373   varient of strcmp() that handles NULL ptrs
374 **/
375 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
376 {
377         if (s1 == s2) {
378                 return 0;
379         }
380         if (s1 == NULL || s2 == NULL) {
381                 return s1?-1:1;
382         }
383         return strcmp(s1, s2);
384 }
385
386
387 /**
388 return the number of bytes occupied by a buffer in ASCII format
389 the result includes the null termination
390 limited by 'n' bytes
391 **/
392 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
393 {
394         size_t len;
395
396         len = strnlen(src, n);
397         if (len+1 <= n) {
398                 len += 1;
399         }
400
401         return len;
402 }
403
404
405 /**
406  Return a string representing a CIFS attribute for a file.
407 **/
408 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib)
409 {
410         int i, len;
411         const struct {
412                 char c;
413                 uint16_t attr;
414         } attr_strs[] = {
415                 {'V', FILE_ATTRIBUTE_VOLUME},
416                 {'D', FILE_ATTRIBUTE_DIRECTORY},
417                 {'A', FILE_ATTRIBUTE_ARCHIVE},
418                 {'H', FILE_ATTRIBUTE_HIDDEN},
419                 {'S', FILE_ATTRIBUTE_SYSTEM},
420                 {'N', FILE_ATTRIBUTE_NORMAL},
421                 {'R', FILE_ATTRIBUTE_READONLY},
422                 {'d', FILE_ATTRIBUTE_DEVICE},
423                 {'t', FILE_ATTRIBUTE_TEMPORARY},
424                 {'s', FILE_ATTRIBUTE_SPARSE},
425                 {'r', FILE_ATTRIBUTE_REPARSE_POINT},
426                 {'c', FILE_ATTRIBUTE_COMPRESSED},
427                 {'o', FILE_ATTRIBUTE_OFFLINE},
428                 {'n', FILE_ATTRIBUTE_NONINDEXED},
429                 {'e', FILE_ATTRIBUTE_ENCRYPTED}
430         };
431         char *ret;
432
433         ret = talloc_array(mem_ctx, char, ARRAY_SIZE(attr_strs)+1);
434         if (!ret) {
435                 return NULL;
436         }
437
438         for (len=i=0; i<ARRAY_SIZE(attr_strs); i++) {
439                 if (attrib & attr_strs[i].attr) {
440                         ret[len++] = attr_strs[i].c;
441                 }
442         }
443
444         ret[len] = 0;
445
446         return ret;
447 }
448
449 /**
450  Set a boolean variable from the text value stored in the passed string.
451  Returns true in success, false if the passed string does not correctly 
452  represent a boolean.
453 **/
454
455 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
456 {
457         if (strwicmp(boolean_string, "yes") == 0 ||
458             strwicmp(boolean_string, "true") == 0 ||
459             strwicmp(boolean_string, "on") == 0 ||
460             strwicmp(boolean_string, "1") == 0) {
461                 *boolean = true;
462                 return true;
463         } else if (strwicmp(boolean_string, "no") == 0 ||
464                    strwicmp(boolean_string, "false") == 0 ||
465                    strwicmp(boolean_string, "off") == 0 ||
466                    strwicmp(boolean_string, "0") == 0) {
467                 *boolean = false;
468                 return true;
469         }
470         return false;
471 }
472
473 /**
474  * Parse a string containing a boolean value.
475  *
476  * val will be set to the read value.
477  *
478  * @retval true if a boolean value was parsed, false otherwise.
479  */
480 _PUBLIC_ bool conv_str_bool(const char * str, bool * val)
481 {
482         char *  end = NULL;
483         long    lval;
484
485         if (str == NULL || *str == '\0') {
486                 return false;
487         }
488
489         lval = strtol(str, &end, 10 /* base */);
490         if (end == NULL || *end != '\0' || end == str) {
491                 return set_boolean(str, val);
492         }
493
494         *val = (lval) ? true : false;
495         return true;
496 }
497
498 /**
499  * Convert a size specification like 16K into an integral number of bytes. 
500  **/
501 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val)
502 {
503         char *              end = NULL;
504         unsigned long long  lval;
505
506         if (str == NULL || *str == '\0') {
507                 return false;
508         }
509
510         lval = strtoull(str, &end, 10 /* base */);
511         if (end == NULL || end == str) {
512                 return false;
513         }
514
515         if (*end) {
516                 if (strwicmp(end, "K") == 0) {
517                         lval *= 1024ULL;
518                 } else if (strwicmp(end, "M") == 0) {
519                         lval *= (1024ULL * 1024ULL);
520                 } else if (strwicmp(end, "G") == 0) {
521                         lval *= (1024ULL * 1024ULL * 1024ULL);
522                 } else if (strwicmp(end, "T") == 0) {
523                         lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL);
524                 } else if (strwicmp(end, "P") == 0) {
525                         lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL * 1024ULL);
526                 } else {
527                         return false;
528                 }
529         }
530
531         *val = (uint64_t)lval;
532         return true;
533 }
534
535 /**
536  * Parse a uint64_t value from a string
537  *
538  * val will be set to the value read.
539  *
540  * @retval true if parsing was successful, false otherwise
541  */
542 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val)
543 {
544         char *              end = NULL;
545         unsigned long long  lval;
546
547         if (str == NULL || *str == '\0') {
548                 return false;
549         }
550
551         lval = strtoull(str, &end, 10 /* base */);
552         if (end == NULL || *end != '\0' || end == str) {
553                 return false;
554         }
555
556         *val = (uint64_t)lval;
557         return true;
558 }
559
560 /**
561 return the number of bytes occupied by a buffer in CH_UTF16 format
562 the result includes the null termination
563 **/
564 _PUBLIC_ size_t utf16_len(const void *buf)
565 {
566         size_t len;
567
568         for (len = 0; SVAL(buf,len); len += 2) ;
569
570         return len + 2;
571 }
572
573 /**
574 return the number of bytes occupied by a buffer in CH_UTF16 format
575 the result includes the null termination
576 limited by 'n' bytes
577 **/
578 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
579 {
580         size_t len;
581
582         for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
583
584         if (len+2 <= n) {
585                 len += 2;
586         }
587
588         return len;
589 }
590
591 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags)
592 {
593         if (flags & (STR_NOALIGN|STR_ASCII))
594                 return 0;
595         return PTR_DIFF(p, base_ptr) & 1;
596 }
597
598 /**
599 Do a case-insensitive, whitespace-ignoring string compare.
600 **/
601 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2)
602 {
603         /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
604         /* appropriate value. */
605         if (psz1 == psz2)
606                 return (0);
607         else if (psz1 == NULL)
608                 return (-1);
609         else if (psz2 == NULL)
610                 return (1);
611
612         /* sync the strings on first non-whitespace */
613         while (1) {
614                 while (isspace((int)*psz1))
615                         psz1++;
616                 while (isspace((int)*psz2))
617                         psz2++;
618                 if (toupper((unsigned char)*psz1) != toupper((unsigned char)*psz2) 
619                     || *psz1 == '\0'
620                     || *psz2 == '\0')
621                         break;
622                 psz1++;
623                 psz2++;
624         }
625         return (*psz1 - *psz2);
626 }
627
628 /**
629  String replace.
630 **/
631 _PUBLIC_ void string_replace(char *s, char oldc, char newc)
632 {
633         while (*s) {
634                 if (*s == oldc) *s = newc;
635                 s++;
636         }
637 }
638
639 /**
640  * Compare 2 strings.
641  *
642  * @note The comparison is case-insensitive.
643  **/
644 _PUBLIC_ bool strequal(const char *s1, const char *s2)
645 {
646         if (s1 == s2)
647                 return true;
648         if (!s1 || !s2)
649                 return false;
650   
651         return strcasecmp(s1,s2) == 0;
652 }