2 Unix SMB/CIFS implementation.
3 Samba utility functions
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
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 2 of the License, or
13 (at your option) any later version.
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.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include "lib/ldb/include/ldb.h"
29 #include "system/iconv.h"
33 * @brief String utilities.
38 Trim the specified elements off the front and back of a string.
40 _PUBLIC_ BOOL trim_string(char *s,const char *front,const char *back)
47 /* Ignore null or empty strings. */
48 if (!s || (s[0] == '\0'))
51 front_len = front? strlen(front) : 0;
52 back_len = back? strlen(back) : 0;
57 while (len && strncmp(s, front, front_len)==0) {
58 /* Must use memmove here as src & dest can
59 * easily overlap. Found by valgrind. JRA. */
60 memmove(s, s+front_len, (len-front_len)+1);
67 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
77 Find the number of 'c' chars in a string
79 _PUBLIC_ size_t count_chars(const char *s, char c)
85 codepoint_t c2 = next_codepoint(s, &size);
94 Safe string copy into a known length string. maxlength does not
95 include the terminating zero.
97 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength)
102 DEBUG(0,("ERROR: NULL dest in safe_strcpy\n"));
107 /* We intentionally write out at the extremity of the destination
108 * string. If the destination is too short (e.g. pstrcpy into mallocd
109 * or fstring) then this should cause an error under a memory
111 dest[maxlength] = '\0';
112 if (PTR_DIFF(&len, dest) > 0) { /* check if destination is on the stack, ok if so */
113 log_suspicious_usage("safe_strcpy", src);
124 if (len > maxlength) {
125 DEBUG(0,("ERROR: string overflow by %u (%u - %u) in safe_strcpy [%.50s]\n",
126 (uint_t)(len-maxlength), (unsigned)len, (unsigned)maxlength, src));
130 memmove(dest, src, len);
136 Safe string cat into a string. maxlength does not
137 include the terminating zero.
139 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength)
141 size_t src_len, dest_len;
144 DEBUG(0,("ERROR: NULL dest in safe_strcat\n"));
152 if (PTR_DIFF(&src_len, dest) > 0) { /* check if destination is on the stack, ok if so */
153 log_suspicious_usage("safe_strcat", src);
156 src_len = strlen(src);
157 dest_len = strlen(dest);
159 if (src_len + dest_len > maxlength) {
160 DEBUG(0,("ERROR: string overflow by %d in safe_strcat [%.50s]\n",
161 (int)(src_len + dest_len - maxlength), src));
162 if (maxlength > dest_len) {
163 memcpy(&dest[dest_len], src, maxlength - dest_len);
169 memcpy(&dest[dest_len], src, src_len);
170 dest[dest_len + src_len] = 0;
175 Like strncpy but always null terminates. Make sure there is room!
176 The variable n should always be one less than the available size.
179 _PUBLIC_ char *StrnCpy(char *dest,const char *src,size_t n)
188 while (n-- && (*d++ = *src++))
196 Routine to get hex characters and turn them into a 16 byte array.
197 the array can be variable length, and any non-hex-numeric
198 characters are skipped. "0xnn" or "0Xnn" is specially catered
201 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
205 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex)
208 size_t num_chars = 0;
209 uint8_t lonybble, hinybble;
210 const char *hexchars = "0123456789ABCDEF";
211 char *p1 = NULL, *p2 = NULL;
213 for (i = 0; i < len && strhex[i] != 0; i++) {
214 if (strncasecmp(hexchars, "0x", 2) == 0) {
215 i++; /* skip two chars */
219 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
222 i++; /* next hex digit */
224 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
227 /* get the two nybbles */
228 hinybble = PTR_DIFF(p1, hexchars);
229 lonybble = PTR_DIFF(p2, hexchars);
231 p[num_chars] = (hinybble << 4) | lonybble;
241 * Parse a hex string and return a data blob.
243 _PUBLIC_ DATA_BLOB strhex_to_data_blob(const char *strhex)
245 DATA_BLOB ret_blob = data_blob(NULL, strlen(strhex)/2+1);
247 ret_blob.length = strhex_to_str((char *)ret_blob.data,
256 * Routine to print a buffer as HEX digits, into an allocated string.
258 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
263 *out_hex_buffer = smb_xmalloc((len*2)+1);
264 hex_buffer = *out_hex_buffer;
266 for (i = 0; i < len; i++)
267 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
271 Check if a string is part of a list.
273 _PUBLIC_ BOOL in_list(const char *s, const char *list, BOOL casesensitive)
281 while (next_token(&p,tok,LIST_SEP,sizeof(tok))) {
283 if (strcmp(tok,s) == 0)
286 if (strcasecmp_m(tok,s) == 0)
294 Set a string value, allocing the space for the string
296 static BOOL string_init(char **dest,const char *src)
300 (*dest) = strdup(src);
301 if ((*dest) == NULL) {
302 DEBUG(0,("Out of memory in string_init\n"));
311 _PUBLIC_ void string_free(char **s)
313 if (s) SAFE_FREE(*s);
317 Set a string value, deallocating any existing space, and allocing the space
320 _PUBLIC_ BOOL string_set(char **dest, const char *src)
323 return string_init(dest,src);
327 Substitute a string for a pattern in another string. Make sure there is
330 This routine looks for pattern in s and replaces it with
331 insert. It may do multiple replacements.
333 Any of " ; ' $ or ` in the insert string are replaced with _
334 if len==0 then the string cannot be extended. This is different from the old
335 use of len==0 which was for no length checks to be done.
338 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len)
343 if (!insert || !pattern || !*pattern || !s)
346 ls = (ssize_t)strlen(s);
347 lp = (ssize_t)strlen(pattern);
348 li = (ssize_t)strlen(insert);
351 len = ls + 1; /* len is number of *bytes* */
353 while (lp <= ls && (p = strstr(s,pattern))) {
354 if (ls + (li-lp) >= len) {
355 DEBUG(0,("ERROR: string overflow by %d in string_sub(%.50s, %d)\n",
356 (int)(ls + (li-lp) - len),
361 memmove(p+li,p+lp,strlen(p+lp)+1);
386 Similar to string_sub() but allows for any character to be substituted.
388 if len==0 then the string cannot be extended. This is different from the old
389 use of len==0 which was for no length checks to be done.
392 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len)
397 if (!insert || !pattern || !s)
400 ls = (ssize_t)strlen(s);
401 lp = (ssize_t)strlen(pattern);
402 li = (ssize_t)strlen(insert);
408 len = ls + 1; /* len is number of *bytes* */
410 while (lp <= ls && (p = strstr(s,pattern))) {
411 if (ls + (li-lp) >= len) {
412 DEBUG(0,("ERROR: string overflow by %d in all_string_sub(%.50s, %d)\n",
413 (int)(ls + (li-lp) - len),
418 memmove(p+li,p+lp,strlen(p+lp)+1);
420 memcpy(p, insert, li);
429 Unescape a URL encoded string, in place.
432 _PUBLIC_ void rfc1738_unescape(char *buf)
436 while ((p=strchr_m(p,'+')))
441 while (p && *p && (p=strchr_m(p,'%'))) {
445 if (c1 >= '0' && c1 <= '9')
447 else if (c1 >= 'A' && c1 <= 'F')
449 else if (c1 >= 'a' && c1 <= 'f')
451 else {p++; continue;}
453 if (c2 >= '0' && c2 <= '9')
455 else if (c2 >= 'A' && c2 <= 'F')
457 else if (c2 >= 'a' && c2 <= 'f')
459 else {p++; continue;}
463 memmove(p+1, p+3, strlen(p+3)+1);
469 size_t valgrind_strlen(const char *s)
472 for(count = 0; *s++; count++)
480 format a string into length-prefixed dotted domain format, as used in NBT
481 and in some ADS structures
483 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s)
488 return talloc_strdup(mem_ctx, "");
490 ret = talloc_size(mem_ctx, strlen(s)+2);
495 memcpy(ret+1, s, strlen(s)+1);
498 for (i=0;ret[i];i++) {
500 char *p = strchr(ret+i+1, '.');
502 ret[i] = p-(ret+i+1);
504 ret[i] = strlen(ret+i+1);
513 * Add a string to an array of strings.
515 * num should be a pointer to an integer that holds the current
516 * number of elements in strings. It will be updated by this function.
518 _PUBLIC_ BOOL add_string_to_array(TALLOC_CTX *mem_ctx,
519 const char *str, const char ***strings, int *num)
521 char *dup_str = talloc_strdup(mem_ctx, str);
523 *strings = talloc_realloc(mem_ctx,
525 const char *, ((*num)+1));
527 if ((*strings == NULL) || (dup_str == NULL))
530 (*strings)[*num] = dup_str;
539 varient of strcmp() that handles NULL ptrs
541 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
546 if (s1 == NULL || s2 == NULL) {
549 return strcmp(s1, s2);
554 return the number of bytes occupied by a buffer in ASCII format
555 the result includes the null termination
558 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
562 len = strnlen(src, n);
572 Return a string representing a CIFS attribute for a file.
574 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib)
581 {'V', FILE_ATTRIBUTE_VOLUME},
582 {'D', FILE_ATTRIBUTE_DIRECTORY},
583 {'A', FILE_ATTRIBUTE_ARCHIVE},
584 {'H', FILE_ATTRIBUTE_HIDDEN},
585 {'S', FILE_ATTRIBUTE_SYSTEM},
586 {'N', FILE_ATTRIBUTE_NORMAL},
587 {'R', FILE_ATTRIBUTE_READONLY},
588 {'d', FILE_ATTRIBUTE_DEVICE},
589 {'t', FILE_ATTRIBUTE_TEMPORARY},
590 {'s', FILE_ATTRIBUTE_SPARSE},
591 {'r', FILE_ATTRIBUTE_REPARSE_POINT},
592 {'c', FILE_ATTRIBUTE_COMPRESSED},
593 {'o', FILE_ATTRIBUTE_OFFLINE},
594 {'n', FILE_ATTRIBUTE_NONINDEXED},
595 {'e', FILE_ATTRIBUTE_ENCRYPTED}
599 ret = talloc_size(mem_ctx, ARRAY_SIZE(attr_strs)+1);
604 for (len=i=0; i<ARRAY_SIZE(attr_strs); i++) {
605 if (attrib & attr_strs[i].attr) {
606 ret[len++] = attr_strs[i].c;
616 Set a boolean variable from the text value stored in the passed string.
617 Returns True in success, False if the passed string does not correctly
621 _PUBLIC_ BOOL set_boolean(const char *boolean_string, BOOL *boolean)
623 if (strwicmp(boolean_string, "yes") == 0 ||
624 strwicmp(boolean_string, "true") == 0 ||
625 strwicmp(boolean_string, "on") == 0 ||
626 strwicmp(boolean_string, "1") == 0) {
629 } else if (strwicmp(boolean_string, "no") == 0 ||
630 strwicmp(boolean_string, "false") == 0 ||
631 strwicmp(boolean_string, "off") == 0 ||
632 strwicmp(boolean_string, "0") == 0) {
640 * Parse a string containing a boolean value.
642 * val will be set to the read value.
644 * @retval True if a boolean value was parsed, False otherwise.
646 _PUBLIC_ BOOL conv_str_bool(const char * str, BOOL * val)
651 if (str == NULL || *str == '\0') {
655 lval = strtol(str, &end, 10 /* base */);
656 if (end == NULL || *end != '\0' || end == str) {
657 return set_boolean(str, val);
660 *val = (lval) ? True : False;
665 * Convert a size specification like 16K into an integral number of bytes.
667 _PUBLIC_ BOOL conv_str_size(const char * str, uint64_t * val)
670 unsigned long long lval;
672 if (str == NULL || *str == '\0') {
676 lval = strtoull(str, &end, 10 /* base */);
677 if (end == NULL || end == str) {
682 if (strwicmp(end, "K") == 0) {
684 } else if (strwicmp(end, "M") == 0) {
685 lval *= (1024ULL * 1024ULL);
686 } else if (strwicmp(end, "G") == 0) {
687 lval *= (1024ULL * 1024ULL * 1024ULL);
688 } else if (strwicmp(end, "T") == 0) {
689 lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL);
690 } else if (strwicmp(end, "P") == 0) {
691 lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL * 1024ULL);
697 *val = (uint64_t)lval;
702 * Parse a uint64_t value from a string
704 * val will be set to the value read.
706 * @retval True if parsing was successful, False otherwise
708 _PUBLIC_ BOOL conv_str_u64(const char * str, uint64_t * val)
711 unsigned long long lval;
713 if (str == NULL || *str == '\0') {
717 lval = strtoull(str, &end, 10 /* base */);
718 if (end == NULL || *end != '\0' || end == str) {
722 *val = (uint64_t)lval;
727 return the number of bytes occupied by a buffer in CH_UTF16 format
728 the result includes the null termination
730 _PUBLIC_ size_t utf16_len(const void *buf)
734 for (len = 0; SVAL(buf,len); len += 2) ;
740 return the number of bytes occupied by a buffer in CH_UTF16 format
741 the result includes the null termination
744 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
748 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
757 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags)
759 if (flags & (STR_NOALIGN|STR_ASCII))
761 return PTR_DIFF(p, base_ptr) & 1;
765 Do a case-insensitive, whitespace-ignoring string compare.
767 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2)
769 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
770 /* appropriate value. */
773 else if (psz1 == NULL)
775 else if (psz2 == NULL)
778 /* sync the strings on first non-whitespace */
780 while (isspace((int)*psz1))
782 while (isspace((int)*psz2))
784 if (toupper((unsigned char)*psz1) != toupper((unsigned char)*psz2)
791 return (*psz1 - *psz2);
797 _PUBLIC_ void string_replace(char *s, char oldc, char newc)
801 if (*s == oldc) *s = newc;
808 * @note The comparison is case-insensitive.
810 _PUBLIC_ BOOL strequal(const char *s1, const char *s2)
817 return strcasecmp(s1,s2) == 0;