aa77d75ad334c47e94fe86adba9dffb5744049ba
[kai/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    Copyright (C) James Peach     2006
9    Copyright (C) Jeremy Allison  1992-2007
10
11    This program is free software; you can redistribute it and/or modify
12    it under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 3 of the License, or
14    (at your option) any later version.
15
16    This program is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19    GNU General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with this program.  If not, see <http://www.gnu.org/licenses/>.
23 */
24
25 #include "includes.h"
26 #include "lib/param/loadparm.h"
27
28 const char toupper_ascii_fast_table[128] = {
29         0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf,
30         0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
31         0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
32         0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
33         0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
34         0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
35         0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
36         0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f
37 };
38
39 /**
40  * Compare 2 strings up to and including the nth char.
41  *
42  * @note The comparison is case-insensitive.
43  **/
44 bool strnequal(const char *s1,const char *s2,size_t n)
45 {
46         if (s1 == s2)
47                 return(true);
48         if (!s1 || !s2 || !n)
49                 return(false);
50
51         return(strncasecmp_m(s1,s2,n)==0);
52 }
53
54 /**
55  Convert a string to "normal" form.
56 **/
57
58 bool strnorm(char *s, int case_default)
59 {
60         if (case_default == CASE_UPPER)
61                 return strupper_m(s);
62         else
63                 return strlower_m(s);
64 }
65
66 /**
67  *  Skip past some strings in a buffer - old version - no checks.
68  *  **/
69
70 char *push_skip_string(char *buf)
71 {
72         buf += strlen(buf) + 1;
73         return(buf);
74 }
75
76 /**
77  Skip past a string in a buffer. Buffer may not be
78  null terminated. end_ptr points to the first byte after
79  then end of the buffer.
80 **/
81
82 char *skip_string(const char *base, size_t len, char *buf)
83 {
84         const char *end_ptr = base + len;
85
86         if (end_ptr < base || !base || !buf || buf >= end_ptr) {
87                 return NULL;
88         }
89
90         /* Skip the string */
91         while (*buf) {
92                 buf++;
93                 if (buf >= end_ptr) {
94                         return NULL;
95                 }
96         }
97         /* Skip the '\0' */
98         buf++;
99         return buf;
100 }
101
102 /**
103  Count the number of characters in a string. Normally this will
104  be the same as the number of bytes in a string for single byte strings,
105  but will be different for multibyte.
106 **/
107
108 size_t str_charnum(const char *s)
109 {
110         size_t ret, converted_size;
111         smb_ucs2_t *tmpbuf2 = NULL;
112         if (!push_ucs2_talloc(talloc_tos(), &tmpbuf2, s, &converted_size)) {
113                 return 0;
114         }
115         ret = strlen_w(tmpbuf2);
116         TALLOC_FREE(tmpbuf2);
117         return ret;
118 }
119
120 bool trim_char(char *s,char cfront,char cback)
121 {
122         bool ret = false;
123         char *ep;
124         char *fp = s;
125
126         /* Ignore null or empty strings. */
127         if (!s || (s[0] == '\0'))
128                 return false;
129
130         if (cfront) {
131                 while (*fp && *fp == cfront)
132                         fp++;
133                 if (!*fp) {
134                         /* We ate the string. */
135                         s[0] = '\0';
136                         return true;
137                 }
138                 if (fp != s)
139                         ret = true;
140         }
141
142         ep = fp + strlen(fp) - 1;
143         if (cback) {
144                 /* Attempt ascii only. Bail for mb strings. */
145                 while ((ep >= fp) && (*ep == cback)) {
146                         ret = true;
147                         if ((ep > fp) && (((unsigned char)ep[-1]) & 0x80)) {
148                                 /* Could be mb... bail back to tim_string. */
149                                 char fs[2], bs[2];
150                                 if (cfront) {
151                                         fs[0] = cfront;
152                                         fs[1] = '\0';
153                                 }
154                                 bs[0] = cback;
155                                 bs[1] = '\0';
156                                 return trim_string(s, cfront ? fs : NULL, bs);
157                         } else {
158                                 ep--;
159                         }
160                 }
161                 if (ep < fp) {
162                         /* We ate the string. */
163                         s[0] = '\0';
164                         return true;
165                 }
166         }
167
168         ep[1] = '\0';
169         memmove(s, fp, ep-fp+2);
170         return ret;
171 }
172
173 /**
174  Like strncpy but always null terminates. Make sure there is room!
175  The variable n should always be one less than the available size.
176 **/
177 char *StrnCpy(char *dest,const char *src,size_t n)
178 {
179         char *d = dest;
180
181         if (!dest) {
182                 smb_panic("ERROR: NULL dest in StrnCpy");
183         }
184
185         if (!src) {
186                 *dest = 0;
187                 return(dest);
188         }
189
190         while (n-- && (*d = *src)) {
191                 d++;
192                 src++;
193         }
194
195         *d = 0;
196         return(dest);
197 }
198
199 /**
200  Check if a string is part of a list.
201 **/
202
203 bool in_list(const char *s, const char *list, bool casesensitive)
204 {
205         char *tok = NULL;
206         bool ret = false;
207         TALLOC_CTX *frame;
208
209         if (!list) {
210                 return false;
211         }
212
213         frame = talloc_stackframe();
214         while (next_token_talloc(frame, &list, &tok,LIST_SEP)) {
215                 if (casesensitive) {
216                         if (strcmp(tok,s) == 0) {
217                                 ret = true;
218                                 break;
219                         }
220                 } else {
221                         if (strcasecmp_m(tok,s) == 0) {
222                                 ret = true;
223                                 break;
224                         }
225                 }
226         }
227         TALLOC_FREE(frame);
228         return ret;
229 }
230
231 /*
232  * Internal guts of talloc_string_sub and talloc_all_string_sub.
233  * talloc version of string_sub2.
234  */
235
236 char *talloc_string_sub2(TALLOC_CTX *mem_ctx, const char *src,
237                         const char *pattern,
238                         const char *insert,
239                         bool remove_unsafe_characters,
240                         bool replace_once,
241                         bool allow_trailing_dollar)
242 {
243         char *p, *in;
244         char *s;
245         char *string;
246         ssize_t ls,lp,li,ld, i;
247
248         if (!insert || !pattern || !*pattern || !src) {
249                 return NULL;
250         }
251
252         string = talloc_strdup(mem_ctx, src);
253         if (string == NULL) {
254                 DEBUG(0, ("talloc_string_sub2: "
255                         "talloc_strdup failed\n"));
256                 return NULL;
257         }
258
259         s = string;
260
261         in = talloc_strdup(mem_ctx, insert);
262         if (!in) {
263                 DEBUG(0, ("talloc_string_sub2: ENOMEM\n"));
264                 return NULL;
265         }
266         ls = (ssize_t)strlen(s);
267         lp = (ssize_t)strlen(pattern);
268         li = (ssize_t)strlen(insert);
269         ld = li - lp;
270
271         for (i=0;i<li;i++) {
272                 switch (in[i]) {
273                         case '$':
274                                 /* allow a trailing $
275                                  * (as in machine accounts) */
276                                 if (allow_trailing_dollar && (i == li - 1 )) {
277                                         break;
278                                 }
279                         case '`':
280                         case '"':
281                         case '\'':
282                         case ';':
283                         case '%':
284                         case '\r':
285                         case '\n':
286                                 if (remove_unsafe_characters) {
287                                         in[i] = '_';
288                                         break;
289                                 }
290                         default:
291                                 /* ok */
292                                 break;
293                 }
294         }
295
296         while ((p = strstr_m(s,pattern))) {
297                 if (ld > 0) {
298                         int offset = PTR_DIFF(s,string);
299                         string = (char *)TALLOC_REALLOC(mem_ctx, string,
300                                                         ls + ld + 1);
301                         if (!string) {
302                                 DEBUG(0, ("talloc_string_sub: out of "
303                                           "memory!\n"));
304                                 TALLOC_FREE(in);
305                                 return NULL;
306                         }
307                         p = string + offset + (p - s);
308                 }
309                 if (li != lp) {
310                         memmove(p+li,p+lp,strlen(p+lp)+1);
311                 }
312                 memcpy(p, in, li);
313                 s = p + li;
314                 ls += ld;
315
316                 if (replace_once) {
317                         break;
318                 }
319         }
320         TALLOC_FREE(in);
321         return string;
322 }
323
324 /* Same as string_sub, but returns a talloc'ed string */
325
326 char *talloc_string_sub(TALLOC_CTX *mem_ctx,
327                         const char *src,
328                         const char *pattern,
329                         const char *insert)
330 {
331         return talloc_string_sub2(mem_ctx, src, pattern, insert,
332                         true, false, false);
333 }
334
335 char *talloc_all_string_sub(TALLOC_CTX *ctx,
336                                 const char *src,
337                                 const char *pattern,
338                                 const char *insert)
339 {
340         return talloc_string_sub2(ctx, src, pattern, insert,
341                         false, false, false);
342 }
343
344 /**
345  Write an octal as a string.
346 **/
347
348 char *octal_string(int i)
349 {
350         char *result;
351         if (i == -1) {
352                 result = talloc_strdup(talloc_tos(), "-1");
353         }
354         else {
355                 result = talloc_asprintf(talloc_tos(), "0%o", i);
356         }
357         SMB_ASSERT(result != NULL);
358         return result;
359 }
360
361
362 /**
363  Truncate a string at a specified length.
364 **/
365
366 char *string_truncate(char *s, unsigned int length)
367 {
368         if (s && strlen(s) > length)
369                 s[length] = 0;
370         return s;
371 }
372
373
374 /***********************************************************************
375  Return the equivalent of doing strrchr 'n' times - always going
376  backwards.
377 ***********************************************************************/
378
379 char *strnrchr_m(const char *s, char c, unsigned int n)
380 {
381         smb_ucs2_t *ws = NULL;
382         char *s2 = NULL;
383         smb_ucs2_t *p;
384         char *ret;
385         size_t converted_size;
386
387         if (!push_ucs2_talloc(talloc_tos(), &ws, s, &converted_size)) {
388                 /* Too hard to try and get right. */
389                 return NULL;
390         }
391         p = strnrchr_w(ws, UCS2_CHAR(c), n);
392         if (!p) {
393                 TALLOC_FREE(ws);
394                 return NULL;
395         }
396         *p = 0;
397         if (!pull_ucs2_talloc(talloc_tos(), &s2, ws, &converted_size)) {
398                 TALLOC_FREE(ws);
399                 /* Too hard to try and get right. */
400                 return NULL;
401         }
402         ret = discard_const_p(char, (s+strlen(s2)));
403         TALLOC_FREE(ws);
404         TALLOC_FREE(s2);
405         return ret;
406 }
407
408 static bool unix_strlower(const char *src, size_t srclen, char *dest, size_t destlen)
409 {
410         size_t size;
411         smb_ucs2_t *buffer = NULL;
412         bool ret;
413
414         if (!convert_string_talloc(talloc_tos(), CH_UNIX, CH_UTF16LE, src, srclen,
415                                    (void **)(void *)&buffer, &size))
416         {
417                 return false;
418         }
419         if (!strlower_w(buffer) && (dest == src)) {
420                 TALLOC_FREE(buffer);
421                 return true;
422         }
423         ret = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, &size);
424         TALLOC_FREE(buffer);
425         return ret;
426 }
427
428 #if 0 /* Alternate function that avoid talloc calls for ASCII and non ASCII */
429
430 /**
431  Convert a string to lower case.
432 **/
433 _PUBLIC_ void strlower_m(char *s)
434 {
435         char *d;
436         struct smb_iconv_handle *iconv_handle;
437
438         iconv_handle = get_iconv_handle();
439
440         d = s;
441
442         while (*s) {
443                 size_t c_size, c_size2;
444                 codepoint_t c = next_codepoint_handle(iconv_handle, s, &c_size);
445                 c_size2 = push_codepoint_handle(iconv_handle, d, tolower_m(c));
446                 if (c_size2 > c_size) {
447                         DEBUG(0,("FATAL: codepoint 0x%x (0x%x) expanded from %d to %d bytes in strlower_m\n",
448                                  c, tolower_m(c), (int)c_size, (int)c_size2));
449                         smb_panic("codepoint expansion in strlower_m\n");
450                 }
451                 s += c_size;
452                 d += c_size2;
453         }
454         *d = 0;
455 }
456
457 #endif
458
459 /**
460  Convert a string to lower case.
461 **/
462
463 bool strlower_m(char *s)
464 {
465         size_t len;
466         int errno_save;
467         bool ret = false;
468
469         /* this is quite a common operation, so we want it to be
470            fast. We optimise for the ascii case, knowing that all our
471            supported multi-byte character sets are ascii-compatible
472            (ie. they match for the first 128 chars) */
473
474         while (*s && !(((unsigned char)s[0]) & 0x80)) {
475                 *s = tolower_m((unsigned char)*s);
476                 s++;
477         }
478
479         if (!*s)
480                 return true;
481
482         /* I assume that lowercased string takes the same number of bytes
483          * as source string even in UTF-8 encoding. (VIV) */
484         len = strlen(s) + 1;
485         errno_save = errno;
486         errno = 0;
487         ret = unix_strlower(s,len,s,len);
488         /* Catch mb conversion errors that may not terminate. */
489         if (errno) {
490                 s[len-1] = '\0';
491         }
492         errno = errno_save;
493         return ret;
494 }
495
496 static bool unix_strupper(const char *src, size_t srclen, char *dest, size_t destlen)
497 {
498         size_t size;
499         smb_ucs2_t *buffer;
500         bool ret;
501
502         if (!push_ucs2_talloc(talloc_tos(), &buffer, src, &size)) {
503                 return false;
504         }
505
506         if (!strupper_w(buffer) && (dest == src)) {
507                 TALLOC_FREE(buffer);
508                 return true;
509         }
510
511         ret = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, &size);
512         TALLOC_FREE(buffer);
513         return ret;
514 }
515
516 #if 0 /* Alternate function that avoid talloc calls for ASCII and non ASCII */
517
518 /**
519  Convert a string to UPPER case.
520 **/
521 _PUBLIC_ void strupper_m(char *s)
522 {
523         char *d;
524         struct smb_iconv_handle *iconv_handle;
525
526         iconv_handle = get_iconv_handle();
527
528         d = s;
529
530         while (*s) {
531                 size_t c_size, c_size2;
532                 codepoint_t c = next_codepoint_handle(iconv_handle, s, &c_size);
533                 c_size2 = push_codepoint_handle(iconv_handle, d, toupper_m(c));
534                 if (c_size2 > c_size) {
535                         DEBUG(0,("FATAL: codepoint 0x%x (0x%x) expanded from %d to %d bytes in strupper_m\n",
536                                  c, toupper_m(c), (int)c_size, (int)c_size2));
537                         smb_panic("codepoint expansion in strupper_m\n");
538                 }
539                 s += c_size;
540                 d += c_size2;
541         }
542         *d = 0;
543 }
544
545 #endif
546
547 /**
548  Convert a string to upper case.
549 **/
550
551 bool strupper_m(char *s)
552 {
553         size_t len;
554         int errno_save;
555         bool ret = false;
556
557         /* this is quite a common operation, so we want it to be
558            fast. We optimise for the ascii case, knowing that all our
559            supported multi-byte character sets are ascii-compatible
560            (ie. they match for the first 128 chars) */
561
562         while (*s && !(((unsigned char)s[0]) & 0x80)) {
563                 *s = toupper_ascii_fast((unsigned char)*s);
564                 s++;
565         }
566
567         if (!*s)
568                 return true;
569
570         /* I assume that lowercased string takes the same number of bytes
571          * as source string even in multibyte encoding. (VIV) */
572         len = strlen(s) + 1;
573         errno_save = errno;
574         errno = 0;
575         ret = unix_strupper(s,len,s,len);
576         /* Catch mb conversion errors that may not terminate. */
577         if (errno) {
578                 s[len-1] = '\0';
579         }
580         errno = errno_save;
581         return ret;
582 }
583
584 /**
585  Just a typesafety wrapper for snprintf into a fstring.
586 **/
587
588 int fstr_sprintf(fstring s, const char *fmt, ...)
589 {
590         va_list ap;
591         int ret;
592
593         va_start(ap, fmt);
594         ret = vsnprintf(s, FSTRING_LEN, fmt, ap);
595         va_end(ap);
596         return ret;
597 }
598
599 /**
600  List of Strings manipulation functions
601 **/
602
603 #define S_LIST_ABS 16 /* List Allocation Block Size */
604
605 /******************************************************************************
606  substitute a specific pattern in a string list
607  *****************************************************************************/
608
609 bool str_list_substitute(char **list, const char *pattern, const char *insert)
610 {
611         TALLOC_CTX *ctx = list;
612         char *p, *s, *t;
613         ssize_t ls, lp, li, ld, i, d;
614
615         if (!list)
616                 return false;
617         if (!pattern)
618                 return false;
619         if (!insert)
620                 return false;
621
622         lp = (ssize_t)strlen(pattern);
623         li = (ssize_t)strlen(insert);
624         ld = li -lp;
625
626         while (*list) {
627                 s = *list;
628                 ls = (ssize_t)strlen(s);
629
630                 while ((p = strstr_m(s, pattern))) {
631                         t = *list;
632                         d = p -t;
633                         if (ld) {
634                                 t = talloc_array(ctx, char, ls +ld +1);
635                                 if (!t) {
636                                         DEBUG(0,("str_list_substitute: "
637                                                 "Unable to allocate memory"));
638                                         return false;
639                                 }
640                                 memcpy(t, *list, d);
641                                 memcpy(t +d +li, p +lp, ls -d -lp +1);
642                                 TALLOC_FREE(*list);
643                                 *list = t;
644                                 ls += ld;
645                                 s = t +d +li;
646                         }
647
648                         for (i = 0; i < li; i++) {
649                                 switch (insert[i]) {
650                                         case '`':
651                                         case '"':
652                                         case '\'':
653                                         case ';':
654                                         case '$':
655                                         case '%':
656                                         case '\r':
657                                         case '\n':
658                                                 t[d +i] = '_';
659                                                 break;
660                                         default:
661                                                 t[d +i] = insert[i];
662                                 }
663                         }
664                 }
665
666                 list++;
667         }
668
669         return true;
670 }
671
672
673 #define IPSTR_LIST_SEP  ","
674 #define IPSTR_LIST_CHAR ','
675
676 /**
677  * Add ip string representation to ipstr list. Used also
678  * as part of @function ipstr_list_make
679  *
680  * @param ipstr_list pointer to string containing ip list;
681  *        MUST BE already allocated and IS reallocated if necessary
682  * @param ipstr_size pointer to current size of ipstr_list (might be changed
683  *        as a result of reallocation)
684  * @param ip IP address which is to be added to list
685  * @return pointer to string appended with new ip and possibly
686  *         reallocated to new length
687  **/
688
689 static char *ipstr_list_add(char **ipstr_list, const struct ip_service *service)
690 {
691         char *new_ipstr = NULL;
692         char addr_buf[INET6_ADDRSTRLEN];
693         int ret;
694
695         /* arguments checking */
696         if (!ipstr_list || !service) {
697                 return NULL;
698         }
699
700         print_sockaddr(addr_buf,
701                         sizeof(addr_buf),
702                         &service->ss);
703
704         /* attempt to convert ip to a string and append colon separator to it */
705         if (*ipstr_list) {
706                 if (service->ss.ss_family == AF_INET) {
707                         /* IPv4 */
708                         ret = asprintf(&new_ipstr, "%s%s%s:%d", *ipstr_list,
709                                        IPSTR_LIST_SEP, addr_buf,
710                                        service->port);
711                 } else {
712                         /* IPv6 */
713                         ret = asprintf(&new_ipstr, "%s%s[%s]:%d", *ipstr_list,
714                                        IPSTR_LIST_SEP, addr_buf,
715                                        service->port);
716                 }
717                 SAFE_FREE(*ipstr_list);
718         } else {
719                 if (service->ss.ss_family == AF_INET) {
720                         /* IPv4 */
721                         ret = asprintf(&new_ipstr, "%s:%d", addr_buf,
722                                        service->port);
723                 } else {
724                         /* IPv6 */
725                         ret = asprintf(&new_ipstr, "[%s]:%d", addr_buf,
726                                        service->port);
727                 }
728         }
729         if (ret == -1) {
730                 return NULL;
731         }
732         *ipstr_list = new_ipstr;
733         return *ipstr_list;
734 }
735
736 /**
737  * Allocate and initialise an ipstr list using ip adresses
738  * passed as arguments.
739  *
740  * @param ipstr_list pointer to string meant to be allocated and set
741  * @param ip_list array of ip addresses to place in the list
742  * @param ip_count number of addresses stored in ip_list
743  * @return pointer to allocated ip string
744  **/
745
746 char *ipstr_list_make(char **ipstr_list,
747                         const struct ip_service *ip_list,
748                         int ip_count)
749 {
750         int i;
751
752         /* arguments checking */
753         if (!ip_list || !ipstr_list) {
754                 return 0;
755         }
756
757         *ipstr_list = NULL;
758
759         /* process ip addresses given as arguments */
760         for (i = 0; i < ip_count; i++) {
761                 *ipstr_list = ipstr_list_add(ipstr_list, &ip_list[i]);
762         }
763
764         return (*ipstr_list);
765 }
766
767
768 /**
769  * Parse given ip string list into array of ip addresses
770  * (as ip_service structures)
771  *    e.g. [IPv6]:port,192.168.1.100:389,192.168.1.78, ...
772  *
773  * @param ipstr ip string list to be parsed
774  * @param ip_list pointer to array of ip addresses which is
775  *        allocated by this function and must be freed by caller
776  * @return number of successfully parsed addresses
777  **/
778
779 int ipstr_list_parse(const char *ipstr_list, struct ip_service **ip_list)
780 {
781         TALLOC_CTX *frame;
782         char *token_str = NULL;
783         size_t count;
784         int i;
785
786         if (!ipstr_list || !ip_list)
787                 return 0;
788
789         count = count_chars(ipstr_list, IPSTR_LIST_CHAR) + 1;
790         if ( (*ip_list = SMB_MALLOC_ARRAY(struct ip_service, count)) == NULL ) {
791                 DEBUG(0,("ipstr_list_parse: malloc failed for %lu entries\n",
792                                         (unsigned long)count));
793                 return 0;
794         }
795
796         frame = talloc_stackframe();
797         for ( i=0; next_token_talloc(frame, &ipstr_list, &token_str,
798                                 IPSTR_LIST_SEP) && i<count; i++ ) {
799                 char *s = token_str;
800                 char *p = strrchr(token_str, ':');
801
802                 if (p) {
803                         *p = 0;
804                         (*ip_list)[i].port = atoi(p+1);
805                 }
806
807                 /* convert single token to ip address */
808                 if (token_str[0] == '[') {
809                         /* IPv6 address. */
810                         s++;
811                         p = strchr(token_str, ']');
812                         if (!p) {
813                                 continue;
814                         }
815                         *p = '\0';
816                 }
817                 if (!interpret_string_addr(&(*ip_list)[i].ss,
818                                         s,
819                                         AI_NUMERICHOST)) {
820                         continue;
821                 }
822         }
823         TALLOC_FREE(frame);
824         return count;
825 }
826
827 /**
828  * Safely free ip string list
829  *
830  * @param ipstr_list ip string list to be freed
831  **/
832
833 void ipstr_list_free(char* ipstr_list)
834 {
835         SAFE_FREE(ipstr_list);
836 }
837
838 /* read a SMB_BIG_UINT from a string */
839 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr)
840 {
841
842         uint64_t val = (uint64_t)-1;
843         const char *p = nptr;
844
845         if (!p) {
846                 if (entptr) {
847                         *entptr = p;
848                 }
849                 return val;
850         }
851
852         while (*p && isspace(*p))
853                 p++;
854
855         sscanf(p,"%"PRIu64,&val);
856         if (entptr) {
857                 while (*p && isdigit(*p))
858                         p++;
859                 *entptr = p;
860         }
861
862         return val;
863 }
864
865 /* Convert a size specification to a count of bytes. We accept the following
866  * suffixes:
867  *          bytes if there is no suffix
868  *      kK  kibibytes
869  *      mM  mebibytes
870  *      gG  gibibytes
871  *      tT  tibibytes
872  *      pP  whatever the ISO name for petabytes is
873  *
874  *  Returns 0 if the string can't be converted.
875  */
876 uint64_t conv_str_size(const char * str)
877 {
878         uint64_t lval;
879         char * end;
880
881         if (str == NULL || *str == '\0') {
882                 return 0;
883         }
884
885         lval = strtoull(str, &end, 10 /* base */);
886
887         if (end == NULL || end == str) {
888                 return 0;
889         }
890
891         if (*end == '\0') {
892                 return lval;
893         }
894
895         if (strwicmp(end, "K") == 0) {
896                 lval *= 1024ULL;
897         } else if (strwicmp(end, "M") == 0) {
898                 lval *= (1024ULL * 1024ULL);
899         } else if (strwicmp(end, "G") == 0) {
900                 lval *= (1024ULL * 1024ULL *
901                          1024ULL);
902         } else if (strwicmp(end, "T") == 0) {
903                 lval *= (1024ULL * 1024ULL *
904                          1024ULL * 1024ULL);
905         } else if (strwicmp(end, "P") == 0) {
906                 lval *= (1024ULL * 1024ULL *
907                          1024ULL * 1024ULL *
908                          1024ULL);
909         } else {
910                 return 0;
911         }
912
913         return lval;
914 }
915
916 /* Append an sprintf'ed string. Double buffer size on demand. Usable without
917  * error checking in between. The indiation that something weird happened is
918  * string==NULL */
919
920 void sprintf_append(TALLOC_CTX *mem_ctx, char **string, ssize_t *len,
921                     size_t *bufsize, const char *fmt, ...)
922 {
923         va_list ap;
924         char *newstr;
925         int ret;
926         bool increased;
927
928         /* len<0 is an internal marker that something failed */
929         if (*len < 0)
930                 goto error;
931
932         if (*string == NULL) {
933                 if (*bufsize == 0)
934                         *bufsize = 128;
935
936                 *string = talloc_array(mem_ctx, char, *bufsize);
937                 if (*string == NULL)
938                         goto error;
939         }
940
941         va_start(ap, fmt);
942         ret = vasprintf(&newstr, fmt, ap);
943         va_end(ap);
944
945         if (ret < 0)
946                 goto error;
947
948         increased = false;
949
950         while ((*len)+ret >= *bufsize) {
951                 increased = true;
952                 *bufsize *= 2;
953                 if (*bufsize >= (1024*1024*256))
954                         goto error;
955         }
956
957         if (increased) {
958                 *string = talloc_realloc(mem_ctx, *string, char,
959                                                *bufsize);
960                 if (*string == NULL) {
961                         goto error;
962                 }
963         }
964
965         StrnCpy((*string)+(*len), newstr, ret);
966         (*len) += ret;
967         free(newstr);
968         return;
969
970  error:
971         *len = -1;
972         *string = NULL;
973 }
974
975 /*
976  * asprintf into a string and strupper_m it after that.
977  */
978
979 int asprintf_strupper_m(char **strp, const char *fmt, ...)
980 {
981         va_list ap;
982         char *result;
983         int ret;
984
985         va_start(ap, fmt);
986         ret = vasprintf(&result, fmt, ap);
987         va_end(ap);
988
989         if (ret == -1)
990                 return -1;
991
992         if (!strupper_m(result)) {
993                 SAFE_FREE(result);
994                 return -1;
995         }
996
997         *strp = result;
998         return ret;
999 }
1000
1001 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...)
1002 {
1003         va_list ap;
1004         char *ret;
1005
1006         va_start(ap, fmt);
1007         ret = talloc_vasprintf(t, fmt, ap);
1008         va_end(ap);
1009
1010         if (ret == NULL) {
1011                 return NULL;
1012         }
1013         if (!strupper_m(ret)) {
1014                 TALLOC_FREE(ret);
1015                 return NULL;
1016         }
1017         return ret;
1018 }
1019
1020 char *talloc_asprintf_strlower_m(TALLOC_CTX *t, const char *fmt, ...)
1021 {
1022         va_list ap;
1023         char *ret;
1024
1025         va_start(ap, fmt);
1026         ret = talloc_vasprintf(t, fmt, ap);
1027         va_end(ap);
1028
1029         if (ret == NULL) {
1030                 return NULL;
1031         }
1032         if (!strlower_m(ret)) {
1033                 TALLOC_FREE(ret);
1034                 return NULL;
1035         }
1036         return ret;
1037 }
1038
1039
1040 /********************************************************************
1041  Check a string for any occurrences of a specified list of invalid
1042  characters.
1043 ********************************************************************/
1044
1045 bool validate_net_name( const char *name,
1046                 const char *invalid_chars,
1047                 int max_len)
1048 {
1049         int i;
1050
1051         if (!name) {
1052                 return false;
1053         }
1054
1055         for ( i=0; i<max_len && name[i]; i++ ) {
1056                 /* fail if strchr_m() finds one of the invalid characters */
1057                 if ( name[i] && strchr_m( invalid_chars, name[i] ) ) {
1058                         return false;
1059                 }
1060         }
1061
1062         return true;
1063 }
1064
1065
1066 /*******************************************************************
1067  Add a shell escape character '\' to any character not in a known list
1068  of characters. UNIX charset format.
1069 *******************************************************************/
1070
1071 #define INCLUDE_LIST "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_/ \t.,"
1072 #define INSIDE_DQUOTE_LIST "$`\n\"\\"
1073
1074 char *escape_shell_string(const char *src)
1075 {
1076         size_t srclen = strlen(src);
1077         char *ret = SMB_MALLOC_ARRAY(char, (srclen * 2) + 1);
1078         char *dest = ret;
1079         bool in_s_quote = false;
1080         bool in_d_quote = false;
1081         bool next_escaped = false;
1082
1083         if (!ret) {
1084                 return NULL;
1085         }
1086
1087         while (*src) {
1088                 size_t c_size;
1089                 codepoint_t c = next_codepoint(src, &c_size);
1090
1091                 if (c == INVALID_CODEPOINT) {
1092                         SAFE_FREE(ret);
1093                         return NULL;
1094                 }
1095
1096                 if (c_size > 1) {
1097                         memcpy(dest, src, c_size);
1098                         src += c_size;
1099                         dest += c_size;
1100                         next_escaped = false;
1101                         continue;
1102                 }
1103
1104                 /*
1105                  * Deal with backslash escaped state.
1106                  * This only lasts for one character.
1107                  */
1108
1109                 if (next_escaped) {
1110                         *dest++ = *src++;
1111                         next_escaped = false;
1112                         continue;
1113                 }
1114
1115                 /*
1116                  * Deal with single quote state. The
1117                  * only thing we care about is exiting
1118                  * this state.
1119                  */
1120
1121                 if (in_s_quote) {
1122                         if (*src == '\'') {
1123                                 in_s_quote = false;
1124                         }
1125                         *dest++ = *src++;
1126                         continue;
1127                 }
1128
1129                 /*
1130                  * Deal with double quote state. The most
1131                  * complex state. We must cope with \, meaning
1132                  * possibly escape next char (depending what it
1133                  * is), ", meaning exit this state, and possibly
1134                  * add an \ escape to any unprotected character
1135                  * (listed in INSIDE_DQUOTE_LIST).
1136                  */
1137
1138                 if (in_d_quote) {
1139                         if (*src == '\\') {
1140                                 /*
1141                                  * Next character might be escaped.
1142                                  * We have to peek. Inside double
1143                                  * quotes only INSIDE_DQUOTE_LIST
1144                                  * characters are escaped by a \.
1145                                  */
1146
1147                                 char nextchar;
1148
1149                                 c = next_codepoint(&src[1], &c_size);
1150                                 if (c == INVALID_CODEPOINT) {
1151                                         SAFE_FREE(ret);
1152                                         return NULL;
1153                                 }
1154                                 if (c_size > 1) {
1155                                         /*
1156                                          * Don't escape the next char.
1157                                          * Just copy the \.
1158                                          */
1159                                         *dest++ = *src++;
1160                                         continue;
1161                                 }
1162
1163                                 nextchar = src[1];
1164
1165                                 if (nextchar && strchr(INSIDE_DQUOTE_LIST,
1166                                                         (int)nextchar)) {
1167                                         next_escaped = true;
1168                                 }
1169                                 *dest++ = *src++;
1170                                 continue;
1171                         }
1172
1173                         if (*src == '\"') {
1174                                 /* Exit double quote state. */
1175                                 in_d_quote = false;
1176                                 *dest++ = *src++;
1177                                 continue;
1178                         }
1179
1180                         /*
1181                          * We know the character isn't \ or ",
1182                          * so escape it if it's any of the other
1183                          * possible unprotected characters.
1184                          */
1185
1186                         if (strchr(INSIDE_DQUOTE_LIST, (int)*src)) {
1187                                 *dest++ = '\\';
1188                         }
1189                         *dest++ = *src++;
1190                         continue;
1191                 }
1192
1193                 /*
1194                  * From here to the end of the loop we're
1195                  * not in the single or double quote state.
1196                  */
1197
1198                 if (*src == '\\') {
1199                         /* Next character must be escaped. */
1200                         next_escaped = true;
1201                         *dest++ = *src++;
1202                         continue;
1203                 }
1204
1205                 if (*src == '\'') {
1206                         /* Go into single quote state. */
1207                         in_s_quote = true;
1208                         *dest++ = *src++;
1209                         continue;
1210                 }
1211
1212                 if (*src == '\"') {
1213                         /* Go into double quote state. */
1214                         in_d_quote = true;
1215                         *dest++ = *src++;
1216                         continue;
1217                 }
1218
1219                 /* Check if we need to escape the character. */
1220
1221                 if (!strchr(INCLUDE_LIST, (int)*src)) {
1222                         *dest++ = '\\';
1223                 }
1224                 *dest++ = *src++;
1225         }
1226         *dest++ = '\0';
1227         return ret;
1228 }
1229
1230 /***************************************************
1231  str_list_make, v3 version. The v4 version does not
1232  look at quoted strings with embedded blanks, so
1233  do NOT merge this function please!
1234 ***************************************************/
1235
1236 #define S_LIST_ABS 16 /* List Allocation Block Size */
1237
1238 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
1239         const char *sep)
1240 {
1241         char **list;
1242         const char *str;
1243         char *s, *tok;
1244         int num, lsize;
1245
1246         if (!string || !*string)
1247                 return NULL;
1248
1249         list = talloc_array(mem_ctx, char *, S_LIST_ABS+1);
1250         if (list == NULL) {
1251                 return NULL;
1252         }
1253         lsize = S_LIST_ABS;
1254
1255         s = talloc_strdup(list, string);
1256         if (s == NULL) {
1257                 DEBUG(0,("str_list_make: Unable to allocate memory"));
1258                 TALLOC_FREE(list);
1259                 return NULL;
1260         }
1261         if (!sep) sep = LIST_SEP;
1262
1263         num = 0;
1264         str = s;
1265
1266         while (next_token_talloc(list, &str, &tok, sep)) {
1267
1268                 if (num == lsize) {
1269                         char **tmp;
1270
1271                         lsize += S_LIST_ABS;
1272
1273                         tmp = talloc_realloc(mem_ctx, list, char *,
1274                                                    lsize + 1);
1275                         if (tmp == NULL) {
1276                                 DEBUG(0,("str_list_make: "
1277                                         "Unable to allocate memory"));
1278                                 TALLOC_FREE(list);
1279                                 return NULL;
1280                         }
1281
1282                         list = tmp;
1283
1284                         memset (&list[num], 0,
1285                                 ((sizeof(char**)) * (S_LIST_ABS +1)));
1286                 }
1287
1288                 list[num] = tok;
1289                 num += 1;
1290         }
1291
1292         list[num] = NULL;
1293
1294         TALLOC_FREE(s);
1295         return list;
1296 }