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 3 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, see <http://www.gnu.org/licenses/>.
25 #include "system/locale.h"
31 * @brief String utilities.
35 Safe string copy into a known length string. maxlength does not
36 include the terminating zero.
38 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength)
43 DEBUG(0,("ERROR: NULL dest in safe_strcpy\n"));
48 /* We intentionally write out at the extremity of the destination
49 * string. If the destination is too short (e.g. pstrcpy into mallocd
50 * or fstring) then this should cause an error under a memory
52 dest[maxlength] = '\0';
53 if (PTR_DIFF(&len, dest) > 0) { /* check if destination is on the stack, ok if so */
54 log_suspicious_usage("safe_strcpy", src);
65 if (len > maxlength) {
66 DEBUG(0,("ERROR: string overflow by %u (%u - %u) in safe_strcpy [%.50s]\n",
67 (unsigned int)(len-maxlength), (unsigned)len, (unsigned)maxlength, src));
71 memmove(dest, src, len);
77 Safe string cat into a string. maxlength does not
78 include the terminating zero.
80 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength)
82 size_t src_len, dest_len;
85 DEBUG(0,("ERROR: NULL dest in safe_strcat\n"));
93 if (PTR_DIFF(&src_len, dest) > 0) { /* check if destination is on the stack, ok if so */
94 log_suspicious_usage("safe_strcat", src);
97 src_len = strlen(src);
98 dest_len = strlen(dest);
100 if (src_len + dest_len > maxlength) {
101 DEBUG(0,("ERROR: string overflow by %d in safe_strcat [%.50s]\n",
102 (int)(src_len + dest_len - maxlength), src));
103 if (maxlength > dest_len) {
104 memcpy(&dest[dest_len], src, maxlength - dest_len);
110 memcpy(&dest[dest_len], src, src_len);
111 dest[dest_len + src_len] = 0;
116 format a string into length-prefixed dotted domain format, as used in NBT
117 and in some ADS structures
119 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s)
124 return talloc_strdup(mem_ctx, "");
126 ret = talloc_array(mem_ctx, char, strlen(s)+2);
131 memcpy(ret+1, s, strlen(s)+1);
134 for (i=0;ret[i];i++) {
136 char *p = strchr(ret+i+1, '.');
138 ret[i] = p-(ret+i+1);
140 ret[i] = strlen(ret+i+1);
145 talloc_set_name_const(ret, ret);
151 * Add a string to an array of strings.
153 * num should be a pointer to an integer that holds the current
154 * number of elements in strings. It will be updated by this function.
156 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
157 const char *str, const char ***strings, int *num)
159 char *dup_str = talloc_strdup(mem_ctx, str);
161 *strings = talloc_realloc(mem_ctx,
163 const char *, ((*num)+1));
165 if ((*strings == NULL) || (dup_str == NULL))
168 (*strings)[*num] = dup_str;
175 * Parse a string containing a boolean value.
177 * val will be set to the read value.
179 * @retval true if a boolean value was parsed, false otherwise.
181 _PUBLIC_ bool conv_str_bool(const char * str, bool * val)
186 if (str == NULL || *str == '\0') {
190 lval = strtol(str, &end, 10 /* base */);
191 if (end == NULL || *end != '\0' || end == str) {
192 return set_boolean(str, val);
195 *val = (lval) ? true : false;
200 * Convert a size specification like 16K into an integral number of bytes.
202 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val)
205 unsigned long long lval;
207 if (str == NULL || *str == '\0') {
211 lval = strtoull(str, &end, 10 /* base */);
212 if (end == NULL || end == str) {
217 if (strwicmp(end, "K") == 0) {
219 } else if (strwicmp(end, "M") == 0) {
220 lval *= (1024ULL * 1024ULL);
221 } else if (strwicmp(end, "G") == 0) {
222 lval *= (1024ULL * 1024ULL * 1024ULL);
223 } else if (strwicmp(end, "T") == 0) {
224 lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL);
225 } else if (strwicmp(end, "P") == 0) {
226 lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL * 1024ULL);
232 *val = (uint64_t)lval;
237 * Parse a uint64_t value from a string
239 * val will be set to the value read.
241 * @retval true if parsing was successful, false otherwise
243 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val)
246 unsigned long long lval;
248 if (str == NULL || *str == '\0') {
252 lval = strtoull(str, &end, 10 /* base */);
253 if (end == NULL || *end != '\0' || end == str) {
257 *val = (uint64_t)lval;
262 Do a case-insensitive, whitespace-ignoring string compare.
264 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2)
266 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
267 /* appropriate value. */
270 else if (psz1 == NULL)
272 else if (psz2 == NULL)
275 /* sync the strings on first non-whitespace */
277 while (isspace((int)*psz1))
279 while (isspace((int)*psz2))
281 if (toupper((unsigned char)*psz1) != toupper((unsigned char)*psz2)
288 return (*psz1 - *psz2);
294 * @note The comparison is case-insensitive.
296 _PUBLIC_ bool strequal(const char *s1, const char *s2)
303 return strcasecmp(s1,s2) == 0;
306 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags)
308 if (flags & (STR_NOALIGN|STR_ASCII))
310 return PTR_DIFF(p, base_ptr) & 1;
316 _PUBLIC_ void string_replace(char *s, char oldc, char newc)
319 if (*s == oldc) *s = newc;