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
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 * @brief String utilities.
32 * Get the next token from a string, return False if none found.
33 * Handles double-quotes.
35 * Based on a routine by GJC@VILLAGE.COM.
36 * Extensively modified by Andrew.Tridgell@anu.edu.au
38 BOOL
next_token(const char **ptr
,char *buff
, const char *sep
, size_t bufsize
)
50 /* default to simple separators */
54 /* find the first non sep char */
55 while (*s
&& strchr_m(sep
,*s
))
62 /* copy over the token */
64 for (quoted
= False
; len
< bufsize
&& *s
&& (quoted
|| !strchr_m(sep
,*s
)); s
++) {
73 *ptr
= (*s
) ? s
+1 : s
;
80 This is like next_token but is not re-entrant and "remembers" the first
81 parameter so you can pass NULL. This is useful for user interface code
82 but beware the fact that it is not re-entrant!
85 static const char *last_ptr
=NULL
;
87 BOOL
next_token_nr(const char **ptr
,char *buff
, const char *sep
, size_t bufsize
)
93 ret
= next_token(ptr
, buff
, sep
, bufsize
);
98 static uint16 tmpbuf
[sizeof(pstring
)];
100 void set_first_token(char *ptr
)
106 Convert list of tokens to array; dependent on above routine.
107 Uses last_ptr from above - bit of a hack.
110 char **toktocliplist(int *ctok
, const char *sep
)
112 char *s
=(char *)last_ptr
;
119 while(*s
&& strchr_m(sep
,*s
))
128 while(*s
&& (!strchr_m(sep
,*s
)))
130 while(*s
&& strchr_m(sep
,*s
))
137 if (!(ret
=iret
=malloc((ictok
+1)*sizeof(char *))))
155 * Case insensitive string compararison.
157 * iconv does not directly give us a way to compare strings in
158 * arbitrary unix character sets -- all we can is convert and then
159 * compare. This is expensive.
161 * As an optimization, we do a first pass that considers only the
162 * prefix of the strings that is entirely 7-bit. Within this, we
163 * check whether they have the same value.
165 * Hopefully this will often give the answer without needing to copy.
166 * In particular it should speed comparisons to literal ascii strings
167 * or comparisons of strings that are "obviously" different.
169 * If we find a non-ascii character we fall back to converting via
172 * This should never be slower than convering the whole thing, and
175 * A different optimization would be to compare for bitwise equality
176 * in the binary encoding. (It would be possible thought hairy to do
177 * both simultaneously.) But in that case if they turn out to be
178 * different, we'd need to restart the whole thing.
180 * Even better is to implement strcasecmp for each encoding and use a
183 int StrCaseCmp(const char *s
, const char *t
)
186 const char * ps
, * pt
;
188 smb_ucs2_t
*buffer_s
, *buffer_t
;
191 for (ps
= s
, pt
= t
; ; ps
++, pt
++) {
195 return 0; /* both ended */
197 return -1; /* s is a prefix */
199 return +1; /* t is a prefix */
200 else if ((*ps
& 0x80) || (*pt
& 0x80))
201 /* not ascii anymore, do it the hard way from here on in */
214 size
= push_ucs2_allocate(&buffer_s
, s
);
215 if (size
== (size_t)-1) {
217 /* Not quite the right answer, but finding the right one
218 under this failure case is expensive, and it's pretty close */
221 size
= push_ucs2_allocate(&buffer_t
, t
);
222 if (size
== (size_t)-1) {
225 /* Not quite the right answer, but finding the right one
226 under this failure case is expensive, and it's pretty close */
229 ret
= strcasecmp_w(buffer_s
, buffer_t
);
237 Case insensitive string compararison, length limited.
239 int StrnCaseCmp(const char *s
, const char *t
, size_t n
)
242 unix_strupper(s
, strlen(s
)+1, buf1
, sizeof(buf1
));
243 unix_strupper(t
, strlen(t
)+1, buf2
, sizeof(buf2
));
244 return strncmp(buf1
,buf2
,n
);
250 * @note The comparison is case-insensitive.
252 BOOL
strequal(const char *s1
, const char *s2
)
259 return(StrCaseCmp(s1
,s2
)==0);
263 * Compare 2 strings up to and including the nth char.
265 * @note The comparison is case-insensitive.
267 BOOL
strnequal(const char *s1
,const char *s2
,size_t n
)
271 if (!s1
|| !s2
|| !n
)
274 return(StrnCaseCmp(s1
,s2
,n
)==0);
278 Compare 2 strings (case sensitive).
281 BOOL
strcsequal(const char *s1
,const char *s2
)
288 return(strcmp(s1
,s2
)==0);
292 Do a case-insensitive, whitespace-ignoring string compare.
295 int strwicmp(const char *psz1
, const char *psz2
)
297 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
298 /* appropriate value. */
301 else if (psz1
== NULL
)
303 else if (psz2
== NULL
)
306 /* sync the strings on first non-whitespace */
308 while (isspace((int)*psz1
))
310 while (isspace((int)*psz2
))
312 if (toupper(*psz1
) != toupper(*psz2
) || *psz1
== '\0'
318 return (*psz1
- *psz2
);
323 Convert a string to upper case, but don't modify it.
326 char *strupper_static(const char *s
)
337 Convert a string to "normal" form.
340 void strnorm(char *s
, int case_default
)
342 if (case_default
== CASE_UPPER
)
349 Check if a string is in "normal" case.
352 BOOL
strisnormal(const char *s
, int case_default
)
354 if (case_default
== CASE_UPPER
)
355 return(!strhaslower(s
));
357 return(!strhasupper(s
));
363 NOTE: oldc and newc must be 7 bit characters
366 void string_replace(pstring s
,char oldc
,char newc
)
370 /* this is quite a common operation, so we want it to be
371 fast. We optimise for the ascii case, knowing that all our
372 supported multi-byte character sets are ascii-compatible
373 (ie. they match for the first 128 chars) */
375 for (p
= (unsigned char *)s
; *p
; p
++) {
376 if (*p
& 0x80) /* mb string - slow path. */
385 /* Slow (mb) path. */
386 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
387 /* With compose characters we must restart from the beginning. JRA. */
390 push_ucs2(NULL
, tmpbuf
, p
, sizeof(tmpbuf
), STR_TERMINATE
);
391 string_replace_w(tmpbuf
, UCS2_CHAR(oldc
), UCS2_CHAR(newc
));
392 pull_ucs2(NULL
, p
, tmpbuf
, -1, sizeof(tmpbuf
), STR_TERMINATE
);
396 Skip past some strings in a buffer.
399 char *skip_string(char *buf
,size_t n
)
402 buf
+= strlen(buf
) + 1;
407 Count the number of characters in a string. Normally this will
408 be the same as the number of bytes in a string for single byte strings,
409 but will be different for multibyte.
412 size_t str_charnum(const char *s
)
414 uint16 tmpbuf2
[sizeof(pstring
)];
415 push_ucs2(NULL
, tmpbuf2
,s
, sizeof(tmpbuf2
), STR_TERMINATE
);
416 return strlen_w(tmpbuf2
);
420 Count the number of characters in a string. Normally this will
421 be the same as the number of bytes in a string for single byte strings,
422 but will be different for multibyte.
425 size_t str_ascii_charnum(const char *s
)
428 push_ascii(tmpbuf2
, s
, sizeof(tmpbuf2
), STR_TERMINATE
);
429 return strlen(tmpbuf2
);
432 BOOL
trim_char(char *s
,char cfront
,char cback
)
438 /* Ignore null or empty strings. */
439 if (!s
|| (s
[0] == '\0'))
443 while (*fp
&& *fp
== cfront
)
446 /* We ate the string. */
454 ep
= fp
+ strlen(fp
) - 1;
456 /* Attempt ascii only. Bail for mb strings. */
457 while ((ep
>= fp
) && (*ep
== cback
)) {
459 if ((ep
> fp
) && (((unsigned char)ep
[-1]) & 0x80)) {
460 /* Could be mb... bail back to tim_string. */
468 return trim_string(s
, cfront
? fs
: NULL
, bs
);
474 /* We ate the string. */
481 memmove(s
, fp
, ep
-fp
+2);
486 Trim the specified elements off the front and back of a string.
489 BOOL
trim_string(char *s
,const char *front
,const char *back
)
496 /* Ignore null or empty strings. */
497 if (!s
|| (s
[0] == '\0'))
500 front_len
= front
? strlen(front
) : 0;
501 back_len
= back
? strlen(back
) : 0;
506 while (len
&& strncmp(s
, front
, front_len
)==0) {
507 /* Must use memmove here as src & dest can
508 * easily overlap. Found by valgrind. JRA. */
509 memmove(s
, s
+front_len
, (len
-front_len
)+1);
516 while ((len
>= back_len
) && strncmp(s
+len
-back_len
,back
,back_len
)==0) {
517 s
[len
-back_len
]='\0';
526 Does a string have any uppercase chars in it?
529 BOOL
strhasupper(const char *s
)
532 push_ucs2(NULL
, tmpbuf
,s
, sizeof(tmpbuf
), STR_TERMINATE
);
533 for(ptr
=tmpbuf
;*ptr
;ptr
++)
540 Does a string have any lowercase chars in it?
543 BOOL
strhaslower(const char *s
)
546 push_ucs2(NULL
, tmpbuf
,s
, sizeof(tmpbuf
), STR_TERMINATE
);
547 for(ptr
=tmpbuf
;*ptr
;ptr
++)
554 Find the number of 'c' chars in a string
557 size_t count_chars(const char *s
,char c
)
561 smb_ucs2_t
*alloc_tmpbuf
= NULL
;
563 if (push_ucs2_allocate(&alloc_tmpbuf
, s
) == (size_t)-1) {
567 for(count
=0,ptr
=alloc_tmpbuf
;*ptr
;ptr
++)
568 if(*ptr
==UCS2_CHAR(c
))
571 SAFE_FREE(alloc_tmpbuf
);
576 Safe string copy into a known length string. maxlength does not
577 include the terminating zero.
580 char *safe_strcpy_fn(const char *fn
, int line
, char *dest
,const char *src
, size_t maxlength
)
585 DEBUG(0,("ERROR: NULL dest in safe_strcpy, called from [%s][%d]\n", fn
, line
));
590 clobber_region(fn
,line
,dest
, maxlength
+1);
598 len
= strnlen(src
, maxlength
+1);
600 if (len
> maxlength
) {
601 DEBUG(0,("ERROR: string overflow by %lu (%lu - %lu) in safe_strcpy [%.50s]\n",
602 (unsigned long)(len
-maxlength
), (unsigned long)len
,
603 (unsigned long)maxlength
, src
));
607 memmove(dest
, src
, len
);
613 Safe string cat into a string. maxlength does not
614 include the terminating zero.
616 char *safe_strcat_fn(const char *fn
, int line
, char *dest
, const char *src
, size_t maxlength
)
618 size_t src_len
, dest_len
;
621 DEBUG(0,("ERROR: NULL dest in safe_strcat, called from [%s][%d]\n", fn
, line
));
628 src_len
= strnlen(src
, maxlength
+ 1);
629 dest_len
= strnlen(dest
, maxlength
+ 1);
632 clobber_region(fn
, line
, dest
+ dest_len
, maxlength
+ 1 - dest_len
);
635 if (src_len
+ dest_len
> maxlength
) {
636 DEBUG(0,("ERROR: string overflow by %d in safe_strcat [%.50s]\n",
637 (int)(src_len
+ dest_len
- maxlength
), src
));
638 if (maxlength
> dest_len
) {
639 memcpy(&dest
[dest_len
], src
, maxlength
- dest_len
);
645 memcpy(&dest
[dest_len
], src
, src_len
);
646 dest
[dest_len
+ src_len
] = 0;
651 Paranoid strcpy into a buffer of given length (includes terminating
652 zero. Strips out all but 'a-Z0-9' and the character in other_safe_chars
653 and replaces with '_'. Deliberately does *NOT* check for multibyte
654 characters. Don't change it !
656 char *alpha_strcpy_fn(const char *fn
, int line
, char *dest
, const char *src
, const char *other_safe_chars
, size_t maxlength
)
661 clobber_region(fn
, line
, dest
, maxlength
);
665 DEBUG(0,("ERROR: NULL dest in alpha_strcpy, called from [%s][%d]\n", fn
, line
));
675 if (len
>= maxlength
)
678 if (!other_safe_chars
)
679 other_safe_chars
= "";
681 for(i
= 0; i
< len
; i
++) {
682 int val
= (src
[i
] & 0xff);
683 if (isupper(val
) || islower(val
) || isdigit(val
) || strchr_m(other_safe_chars
, val
))
695 Like strncpy but always null terminates. Make sure there is room!
696 The variable n should always be one less than the available size.
698 char *StrnCpy_fn(const char *fn
, int line
,char *dest
,const char *src
,size_t n
)
703 clobber_region(fn
, line
, dest
, n
+1);
707 DEBUG(0,("ERROR: NULL dest in StrnCpy, called from [%s][%d]\n", fn
, line
));
716 while (n
-- && (*d
= *src
)) {
727 Like strncpy but copies up to the character marker. always null terminates.
728 returns a pointer to the character marker in the source string (src).
731 static char *strncpyn(char *dest
, const char *src
, size_t n
, char c
)
737 clobber_region(dest
, n
+1);
739 p
= strchr_m(src
, c
);
741 DEBUG(5, ("strncpyn: separator character (%c) not found\n", c
));
745 str_len
= PTR_DIFF(p
, src
);
746 strncpy(dest
, src
, MIN(n
, str_len
));
747 dest
[str_len
] = '\0';
754 Routine to get hex characters and turn them into a 16 byte array.
755 the array can be variable length, and any non-hex-numeric
756 characters are skipped. "0xnn" or "0Xnn" is specially catered
759 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
763 size_t strhex_to_str(char *p
, size_t len
, const char *strhex
)
766 size_t num_chars
= 0;
767 unsigned char lonybble
, hinybble
;
768 const char *hexchars
= "0123456789ABCDEF";
769 char *p1
= NULL
, *p2
= NULL
;
771 for (i
= 0; i
< len
&& strhex
[i
] != 0; i
++) {
772 if (strnequal(hexchars
, "0x", 2)) {
773 i
++; /* skip two chars */
777 if (!(p1
= strchr_m(hexchars
, toupper(strhex
[i
]))))
780 i
++; /* next hex digit */
782 if (!(p2
= strchr_m(hexchars
, toupper(strhex
[i
]))))
785 /* get the two nybbles */
786 hinybble
= PTR_DIFF(p1
, hexchars
);
787 lonybble
= PTR_DIFF(p2
, hexchars
);
789 p
[num_chars
] = (hinybble
<< 4) | lonybble
;
798 DATA_BLOB
strhex_to_data_blob(const char *strhex
)
800 DATA_BLOB ret_blob
= data_blob(NULL
, strlen(strhex
)/2+1);
802 ret_blob
.length
= strhex_to_str(ret_blob
.data
,
810 * Routine to print a buffer as HEX digits, into an allocated string.
813 void hex_encode(const unsigned char *buff_in
, size_t len
, char **out_hex_buffer
)
818 *out_hex_buffer
= smb_xmalloc((len
*2)+1);
819 hex_buffer
= *out_hex_buffer
;
821 for (i
= 0; i
< len
; i
++)
822 slprintf(&hex_buffer
[i
*2], 3, "%02X", buff_in
[i
]);
826 Check if a string is part of a list.
829 BOOL
in_list(char *s
,char *list
,BOOL casesensitive
)
837 while (next_token(&p
,tok
,LIST_SEP
,sizeof(tok
))) {
839 if (strcmp(tok
,s
) == 0)
842 if (StrCaseCmp(tok
,s
) == 0)
849 /* this is used to prevent lots of mallocs of size 1 */
850 static char *null_string
= NULL
;
853 Set a string value, allocing the space for the string
856 static BOOL
string_init(char **dest
,const char *src
)
866 if((null_string
= (char *)malloc(1)) == NULL
) {
867 DEBUG(0,("string_init: malloc fail for null_string.\n"));
874 (*dest
) = strdup(src
);
875 if ((*dest
) == NULL
) {
876 DEBUG(0,("Out of memory in string_init\n"));
887 void string_free(char **s
)
891 if (*s
== null_string
)
897 Set a string value, deallocating any existing space, and allocing the space
901 BOOL
string_set(char **dest
,const char *src
)
904 return(string_init(dest
,src
));
908 Substitute a string for a pattern in another string. Make sure there is
911 This routine looks for pattern in s and replaces it with
912 insert. It may do multiple replacements.
914 Any of " ; ' $ or ` in the insert string are replaced with _
915 if len==0 then the string cannot be extended. This is different from the old
916 use of len==0 which was for no length checks to be done.
919 void string_sub(char *s
,const char *pattern
, const char *insert
, size_t len
)
924 if (!insert
|| !pattern
|| !*pattern
|| !s
)
927 ls
= (ssize_t
)strlen(s
);
928 lp
= (ssize_t
)strlen(pattern
);
929 li
= (ssize_t
)strlen(insert
);
932 len
= ls
+ 1; /* len is number of *bytes* */
934 while (lp
<= ls
&& (p
= strstr_m(s
,pattern
))) {
935 if (ls
+ (li
-lp
) >= len
) {
936 DEBUG(0,("ERROR: string overflow by %d in string_sub(%.50s, %d)\n",
937 (int)(ls
+ (li
-lp
) - len
),
942 memmove(p
+li
,p
+lp
,strlen(p
+lp
)+1);
965 void fstring_sub(char *s
,const char *pattern
,const char *insert
)
967 string_sub(s
, pattern
, insert
, sizeof(fstring
));
970 void pstring_sub(char *s
,const char *pattern
,const char *insert
)
972 string_sub(s
, pattern
, insert
, sizeof(pstring
));
976 Similar to string_sub, but it will accept only allocated strings
977 and may realloc them so pay attention at what you pass on no
978 pointers inside strings, no pstrings or const may be passed
982 char *realloc_string_sub(char *string
, const char *pattern
, const char *insert
)
986 ssize_t ls
,lp
,li
,ld
, i
;
988 if (!insert
|| !pattern
|| !*pattern
|| !string
|| !*string
)
995 DEBUG(0, ("realloc_string_sub: out of memory!\n"));
998 ls
= (ssize_t
)strlen(s
);
999 lp
= (ssize_t
)strlen(pattern
);
1000 li
= (ssize_t
)strlen(insert
);
1002 for (i
=0;i
<li
;i
++) {
1019 while ((p
= strstr_m(s
,pattern
))) {
1021 int offset
= PTR_DIFF(s
,string
);
1022 char *t
= Realloc(string
, ls
+ ld
+ 1);
1024 DEBUG(0, ("realloc_string_sub: out of memory!\n"));
1029 p
= t
+ offset
+ (p
- s
);
1032 memmove(p
+li
,p
+lp
,strlen(p
+lp
)+1);
1043 Similar to string_sub() but allows for any character to be substituted.
1045 if len==0 then the string cannot be extended. This is different from the old
1046 use of len==0 which was for no length checks to be done.
1049 void all_string_sub(char *s
,const char *pattern
,const char *insert
, size_t len
)
1054 if (!insert
|| !pattern
|| !s
)
1057 ls
= (ssize_t
)strlen(s
);
1058 lp
= (ssize_t
)strlen(pattern
);
1059 li
= (ssize_t
)strlen(insert
);
1065 len
= ls
+ 1; /* len is number of *bytes* */
1067 while (lp
<= ls
&& (p
= strstr_m(s
,pattern
))) {
1068 if (ls
+ (li
-lp
) >= len
) {
1069 DEBUG(0,("ERROR: string overflow by %d in all_string_sub(%.50s, %d)\n",
1070 (int)(ls
+ (li
-lp
) - len
),
1071 pattern
, (int)len
));
1075 memmove(p
+li
,p
+lp
,strlen(p
+lp
)+1);
1077 memcpy(p
, insert
, li
);
1084 Similar to all_string_sub but for unicode strings.
1085 Return a new allocated unicode string.
1086 similar to string_sub() but allows for any character to be substituted.
1090 static smb_ucs2_t
*all_string_sub_w(const smb_ucs2_t
*s
, const smb_ucs2_t
*pattern
,
1091 const smb_ucs2_t
*insert
)
1094 const smb_ucs2_t
*sp
;
1095 size_t lr
, lp
, li
, lt
;
1097 if (!insert
|| !pattern
|| !*pattern
|| !s
)
1100 lt
= (size_t)strlen_w(s
);
1101 lp
= (size_t)strlen_w(pattern
);
1102 li
= (size_t)strlen_w(insert
);
1105 const smb_ucs2_t
*st
= s
;
1107 while ((sp
= strstr_w(st
, pattern
))) {
1113 r
= rp
= (smb_ucs2_t
*)malloc((lt
+ 1)*(sizeof(smb_ucs2_t
)));
1115 DEBUG(0, ("all_string_sub_w: out of memory!\n"));
1119 while ((sp
= strstr_w(s
, pattern
))) {
1120 memcpy(rp
, s
, (sp
- s
));
1121 rp
+= ((sp
- s
) / sizeof(smb_ucs2_t
));
1122 memcpy(rp
, insert
, (li
* sizeof(smb_ucs2_t
)));
1126 lr
= ((rp
- r
) / sizeof(smb_ucs2_t
));
1128 memcpy(rp
, s
, ((lt
- lr
) * sizeof(smb_ucs2_t
)));
1136 smb_ucs2_t
*all_string_sub_wa(smb_ucs2_t
*s
, const char *pattern
,
1141 if (!insert
|| !pattern
|| !s
)
1143 push_ucs2(NULL
, p
, pattern
, sizeof(wpstring
) - 1, STR_TERMINATE
);
1144 push_ucs2(NULL
, i
, insert
, sizeof(wpstring
) - 1, STR_TERMINATE
);
1145 return all_string_sub_w(s
, p
, i
);
1150 Splits out the front and back at a separator.
1153 static void split_at_last_component(char *path
, char *front
, char sep
, char *back
)
1155 char *p
= strrchr_m(path
, sep
);
1161 pstrcpy(front
, path
);
1175 Write an octal as a string.
1178 const char *octal_string(int i
)
1180 static char ret
[64];
1183 slprintf(ret
, sizeof(ret
)-1, "0%o", i
);
1189 Truncate a string at a specified length.
1192 char *string_truncate(char *s
, unsigned int length
)
1194 if (s
&& strlen(s
) > length
)
1200 Strchr and strrchr_m are very hard to do on general multi-byte strings.
1201 We convert via ucs2 for now.
1204 char *strchr_m(const char *src
, char c
)
1211 /* characters below 0x3F are guaranteed to not appear in
1212 non-initial position in multi-byte charsets */
1213 if ((c
& 0xC0) == 0) {
1214 return strchr(src
, c
);
1217 /* this is quite a common operation, so we want it to be
1218 fast. We optimise for the ascii case, knowing that all our
1219 supported multi-byte character sets are ascii-compatible
1220 (ie. they match for the first 128 chars) */
1222 for (s
= src
; *s
&& !(((unsigned char)s
[0]) & 0x80); s
++) {
1230 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
1231 /* With compose characters we must restart from the beginning. JRA. */
1235 push_ucs2(NULL
, ws
, s
, sizeof(ws
), STR_TERMINATE
);
1236 p
= strchr_w(ws
, UCS2_CHAR(c
));
1240 pull_ucs2_pstring(s2
, ws
);
1241 return (char *)(s
+strlen(s2
));
1244 char *strrchr_m(const char *s
, char c
)
1246 /* characters below 0x3F are guaranteed to not appear in
1247 non-initial position in multi-byte charsets */
1248 if ((c
& 0xC0) == 0) {
1249 return strrchr(s
, c
);
1252 /* this is quite a common operation, so we want it to be
1253 fast. We optimise for the ascii case, knowing that all our
1254 supported multi-byte character sets are ascii-compatible
1255 (ie. they match for the first 128 chars). Also, in Samba
1256 we only search for ascii characters in 'c' and that
1257 in all mb character sets with a compound character
1258 containing c, if 'c' is not a match at position
1259 p, then p[-1] > 0x7f. JRA. */
1262 size_t len
= strlen(s
);
1264 BOOL got_mb
= False
;
1271 /* Could be a match. Part of a multibyte ? */
1272 if ((cp
> s
) && (((unsigned char)cp
[-1]) & 0x80)) {
1273 /* Yep - go slow :-( */
1277 /* No - we have a match ! */
1280 } while (cp
-- != s
);
1285 /* String contained a non-ascii char. Slow path. */
1291 push_ucs2(NULL
, ws
, s
, sizeof(ws
), STR_TERMINATE
);
1292 p
= strrchr_w(ws
, UCS2_CHAR(c
));
1296 pull_ucs2_pstring(s2
, ws
);
1297 return (char *)(s
+strlen(s2
));
1301 /***********************************************************************
1302 Return the equivalent of doing strrchr 'n' times - always going
1304 ***********************************************************************/
1306 char *strnrchr_m(const char *s
, char c
, unsigned int n
)
1312 push_ucs2(NULL
, ws
, s
, sizeof(ws
), STR_TERMINATE
);
1313 p
= strnrchr_w(ws
, UCS2_CHAR(c
), n
);
1317 pull_ucs2_pstring(s2
, ws
);
1318 return (char *)(s
+strlen(s2
));
1321 /***********************************************************************
1322 strstr_m - We convert via ucs2 for now.
1323 ***********************************************************************/
1325 char *strstr_m(const char *src
, const char *findstr
)
1328 smb_ucs2_t
*src_w
, *find_w
;
1333 size_t findstr_len
= 0;
1335 /* for correctness */
1340 /* Samba does single character findstr calls a *lot*. */
1341 if (findstr
[1] == '\0')
1342 return strchr_m(src
, *findstr
);
1344 /* We optimise for the ascii case, knowing that all our
1345 supported multi-byte character sets are ascii-compatible
1346 (ie. they match for the first 128 chars) */
1348 for (s
= src
; *s
&& !(((unsigned char)s
[0]) & 0x80); s
++) {
1349 if (*s
== *findstr
) {
1351 findstr_len
= strlen(findstr
);
1353 if (strncmp(s
, findstr
, findstr_len
) == 0) {
1362 #if 1 /* def BROKEN_UNICODE_COMPOSE_CHARACTERS */
1363 /* 'make check' fails unless we do this */
1365 /* With compose characters we must restart from the beginning. JRA. */
1369 if (push_ucs2_allocate(&src_w
, src
) == (size_t)-1) {
1370 DEBUG(0,("strstr_m: src malloc fail\n"));
1374 if (push_ucs2_allocate(&find_w
, findstr
) == (size_t)-1) {
1376 DEBUG(0,("strstr_m: find malloc fail\n"));
1380 p
= strstr_w(src_w
, find_w
);
1389 if (pull_ucs2_allocate(&s2
, src_w
) == (size_t)-1) {
1392 DEBUG(0,("strstr_m: dest malloc fail\n"));
1395 retp
= (char *)(s
+strlen(s2
));
1403 Convert a string to lower case.
1406 void strlower_m(char *s
)
1411 /* this is quite a common operation, so we want it to be
1412 fast. We optimise for the ascii case, knowing that all our
1413 supported multi-byte character sets are ascii-compatible
1414 (ie. they match for the first 128 chars) */
1416 while (*s
&& !(((unsigned char)s
[0]) & 0x80)) {
1417 *s
= tolower((unsigned char)*s
);
1424 /* I assume that lowercased string takes the same number of bytes
1425 * as source string even in UTF-8 encoding. (VIV) */
1426 len
= strlen(s
) + 1;
1429 unix_strlower(s
,len
,s
,len
);
1430 /* Catch mb conversion errors that may not terminate. */
1437 Convert a string to upper case.
1440 void strupper_m(char *s
)
1445 /* this is quite a common operation, so we want it to be
1446 fast. We optimise for the ascii case, knowing that all our
1447 supported multi-byte character sets are ascii-compatible
1448 (ie. they match for the first 128 chars) */
1450 while (*s
&& !(((unsigned char)s
[0]) & 0x80)) {
1451 *s
= toupper((unsigned char)*s
);
1458 /* I assume that lowercased string takes the same number of bytes
1459 * as source string even in multibyte encoding. (VIV) */
1460 len
= strlen(s
) + 1;
1463 unix_strupper(s
,len
,s
,len
);
1464 /* Catch mb conversion errors that may not terminate. */
1471 Return a RFC2254 binary string representation of a buffer.
1472 Used in LDAP filters.
1476 char *binary_string(char *buf
, int len
)
1480 const char *hex
= "0123456789ABCDEF";
1481 s
= malloc(len
* 3 + 1);
1484 for (j
=i
=0;i
<len
;i
++) {
1486 s
[j
+1] = hex
[((unsigned char)buf
[i
]) >> 4];
1487 s
[j
+2] = hex
[((unsigned char)buf
[i
]) & 0xF];
1495 Just a typesafety wrapper for snprintf into a pstring.
1498 int pstr_sprintf(pstring s
, const char *fmt
, ...)
1504 ret
= vsnprintf(s
, PSTRING_LEN
, fmt
, ap
);
1511 Just a typesafety wrapper for snprintf into a fstring.
1514 int fstr_sprintf(fstring s
, const char *fmt
, ...)
1520 ret
= vsnprintf(s
, FSTRING_LEN
, fmt
, ap
);
1526 #if !defined(HAVE_STRNDUP) || defined(BROKEN_STRNDUP)
1528 Some platforms don't have strndup.
1531 char *strndup(const char *s
, size_t n
)
1546 #if !defined(HAVE_STRNLEN) || defined(BROKEN_STRNLEN)
1548 Some platforms don't have strnlen
1551 size_t strnlen(const char *s
, size_t n
)
1554 for (i
=0; s
[i
] && i
<n
; i
++)
1561 List of Strings manipulation functions
1564 #define S_LIST_ABS 16 /* List Allocation Block Size */
1566 char **str_list_make(const char *string
, const char *sep
)
1568 char **list
, **rlist
;
1574 if (!string
|| !*string
)
1578 DEBUG(0,("str_list_make: Unable to allocate memory"));
1581 if (!sep
) sep
= LIST_SEP
;
1587 while (next_token(&str
, tok
, sep
, sizeof(tok
))) {
1589 lsize
+= S_LIST_ABS
;
1590 rlist
= (char **)Realloc(list
, ((sizeof(char **)) * (lsize
+1)));
1592 DEBUG(0,("str_list_make: Unable to allocate memory"));
1593 str_list_free(&list
);
1598 memset (&list
[num
], 0, ((sizeof(char**)) * (S_LIST_ABS
+1)));
1601 list
[num
] = strdup(tok
);
1603 DEBUG(0,("str_list_make: Unable to allocate memory"));
1604 str_list_free(&list
);
1616 BOOL
str_list_copy(char ***dest
, const char **src
)
1618 char **list
, **rlist
;
1630 lsize
+= S_LIST_ABS
;
1631 rlist
= (char **)Realloc(list
, ((sizeof(char **)) * (lsize
+1)));
1633 DEBUG(0,("str_list_copy: Unable to re-allocate memory"));
1634 str_list_free(&list
);
1638 memset (&list
[num
], 0, ((sizeof(char **)) * (S_LIST_ABS
+1)));
1641 list
[num
] = strdup(src
[num
]);
1643 DEBUG(0,("str_list_copy: Unable to allocate memory"));
1644 str_list_free(&list
);
1656 * Return true if all the elements of the list match exactly.
1658 BOOL
str_list_compare(char **list1
, char **list2
)
1662 if (!list1
|| !list2
)
1663 return (list1
== list2
);
1665 for (num
= 0; list1
[num
]; num
++) {
1668 if (!strcsequal(list1
[num
], list2
[num
]))
1672 return False
; /* if list2 has more elements than list1 fail */
1677 void str_list_free(char ***list
)
1681 if (!list
|| !*list
)
1684 for(; *tlist
; tlist
++)
1689 /******************************************************************************
1690 version of standard_sub_basic() for string lists; uses alloc_sub_basic()
1692 *****************************************************************************/
1694 BOOL
str_list_sub_basic( char **list
, const char *smb_name
)
1700 tmpstr
= alloc_sub_basic(smb_name
, s
);
1702 DEBUG(0,("str_list_sub_basic: alloc_sub_basic() return NULL!\n"));
1715 /******************************************************************************
1716 substritute a specific pattern in a string list
1717 *****************************************************************************/
1719 BOOL
str_list_substitute(char **list
, const char *pattern
, const char *insert
)
1722 ssize_t ls
, lp
, li
, ld
, i
, d
;
1731 lp
= (ssize_t
)strlen(pattern
);
1732 li
= (ssize_t
)strlen(insert
);
1737 ls
= (ssize_t
)strlen(s
);
1739 while ((p
= strstr_m(s
, pattern
))) {
1743 t
= (char *) malloc(ls
+ld
+1);
1745 DEBUG(0,("str_list_substitute: Unable to allocate memory"));
1748 memcpy(t
, *list
, d
);
1749 memcpy(t
+d
+li
, p
+lp
, ls
-d
-lp
+1);
1756 for (i
= 0; i
< li
; i
++) {
1757 switch (insert
[i
]) {
1769 t
[d
+i
] = insert
[i
];
1782 #define IPSTR_LIST_SEP ","
1783 #define IPSTR_LIST_CHAR ','
1786 * Add ip string representation to ipstr list. Used also
1787 * as part of @function ipstr_list_make
1789 * @param ipstr_list pointer to string containing ip list;
1790 * MUST BE already allocated and IS reallocated if necessary
1791 * @param ipstr_size pointer to current size of ipstr_list (might be changed
1792 * as a result of reallocation)
1793 * @param ip IP address which is to be added to list
1794 * @return pointer to string appended with new ip and possibly
1795 * reallocated to new length
1798 char* ipstr_list_add(char** ipstr_list
, const struct ip_service
*service
)
1800 char* new_ipstr
= NULL
;
1802 /* arguments checking */
1803 if (!ipstr_list
|| !service
) return NULL
;
1805 /* attempt to convert ip to a string and append colon separator to it */
1807 asprintf(&new_ipstr
, "%s%s%s:%d", *ipstr_list
, IPSTR_LIST_SEP
,
1808 inet_ntoa(service
->ip
), service
->port
);
1809 SAFE_FREE(*ipstr_list
);
1811 asprintf(&new_ipstr
, "%s:%d", inet_ntoa(service
->ip
), service
->port
);
1813 *ipstr_list
= new_ipstr
;
1819 * Allocate and initialise an ipstr list using ip adresses
1820 * passed as arguments.
1822 * @param ipstr_list pointer to string meant to be allocated and set
1823 * @param ip_list array of ip addresses to place in the list
1824 * @param ip_count number of addresses stored in ip_list
1825 * @return pointer to allocated ip string
1828 char* ipstr_list_make(char** ipstr_list
, const struct ip_service
* ip_list
, int ip_count
)
1832 /* arguments checking */
1833 if (!ip_list
&& !ipstr_list
) return 0;
1837 /* process ip addresses given as arguments */
1838 for (i
= 0; i
< ip_count
; i
++)
1839 *ipstr_list
= ipstr_list_add(ipstr_list
, &ip_list
[i
]);
1841 return (*ipstr_list
);
1846 * Parse given ip string list into array of ip addresses
1847 * (as ip_service structures)
1848 * e.g. 192.168.1.100:389,192.168.1.78, ...
1850 * @param ipstr ip string list to be parsed
1851 * @param ip_list pointer to array of ip addresses which is
1852 * allocated by this function and must be freed by caller
1853 * @return number of succesfully parsed addresses
1856 int ipstr_list_parse(const char* ipstr_list
, struct ip_service
**ip_list
)
1862 if (!ipstr_list
|| !ip_list
)
1865 count
= count_chars(ipstr_list
, IPSTR_LIST_CHAR
) + 1;
1866 if ( (*ip_list
= (struct ip_service
*)malloc(count
* sizeof(struct ip_service
))) == NULL
) {
1867 DEBUG(0,("ipstr_list_parse: malloc failed for %lu entries\n", (unsigned long)count
));
1872 next_token(&ipstr_list
, token_str
, IPSTR_LIST_SEP
, FSTRING_LEN
) && i
<count
;
1875 struct in_addr addr
;
1877 char *p
= strchr(token_str
, ':');
1884 /* convert single token to ip address */
1885 if ( (addr
.s_addr
= inet_addr(token_str
)) == INADDR_NONE
)
1888 (*ip_list
)[i
].ip
= addr
;
1889 (*ip_list
)[i
].port
= port
;
1897 * Safely free ip string list
1899 * @param ipstr_list ip string list to be freed
1902 void ipstr_list_free(char* ipstr_list
)
1904 SAFE_FREE(ipstr_list
);
1909 Unescape a URL encoded string, in place.
1912 void rfc1738_unescape(char *buf
)
1916 while (p
&& *p
&& (p
=strchr_m(p
,'%'))) {
1920 if (c1
>= '0' && c1
<= '9')
1922 else if (c1
>= 'A' && c1
<= 'F')
1924 else if (c1
>= 'a' && c1
<= 'f')
1926 else {p
++; continue;}
1928 if (c2
>= '0' && c2
<= '9')
1930 else if (c2
>= 'A' && c2
<= 'F')
1932 else if (c2
>= 'a' && c2
<= 'f')
1934 else {p
++; continue;}
1938 memmove(p
+1, p
+3, strlen(p
+3)+1);
1943 static const char *b64
= "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
1946 * Decode a base64 string into a DATA_BLOB - simple and slow algorithm
1948 DATA_BLOB
base64_decode_data_blob(const char *s
)
1950 int bit_offset
, byte_offset
, idx
, i
, n
;
1951 DATA_BLOB decoded
= data_blob(s
, strlen(s
)+1);
1952 unsigned char *d
= decoded
.data
;
1957 while (*s
&& (p
=strchr_m(b64
,*s
))) {
1958 idx
= (int)(p
- b64
);
1959 byte_offset
= (i
*6)/8;
1960 bit_offset
= (i
*6)%8;
1961 d
[byte_offset
] &= ~((1<<(8-bit_offset
))-1);
1962 if (bit_offset
< 3) {
1963 d
[byte_offset
] |= (idx
<< (2-bit_offset
));
1966 d
[byte_offset
] |= (idx
>> (bit_offset
-2));
1967 d
[byte_offset
+1] = 0;
1968 d
[byte_offset
+1] |= (idx
<< (8-(bit_offset
-2))) & 0xFF;
1974 if ((n
> 0) && (*s
== '=')) {
1984 * Decode a base64 string in-place - wrapper for the above
1986 void base64_decode_inplace(char *s
)
1988 DATA_BLOB decoded
= base64_decode_data_blob(s
);
1990 if ( decoded
.length
!= 0 ) {
1991 memcpy(s
, decoded
.data
, decoded
.length
);
1993 /* null terminate */
1994 s
[decoded
.length
] = '\0';
1999 data_blob_free(&decoded
);
2003 * Encode a base64 string into a malloc()ed string caller to free.
2005 *From SQUID: adopted from http://ftp.sunet.se/pub2/gnu/vm/base64-encode.c with adjustments
2007 char * base64_encode_data_blob(DATA_BLOB data
)
2012 size_t len
= data
.length
;
2013 size_t output_len
= data
.length
* 2;
2014 char *result
= malloc(output_len
); /* get us plenty of space */
2016 while (len
-- && out_cnt
< (data
.length
* 2) - 5) {
2017 int c
= (unsigned char) *(data
.data
++);
2020 if (char_count
== 3) {
2021 result
[out_cnt
++] = b64
[bits
>> 18];
2022 result
[out_cnt
++] = b64
[(bits
>> 12) & 0x3f];
2023 result
[out_cnt
++] = b64
[(bits
>> 6) & 0x3f];
2024 result
[out_cnt
++] = b64
[bits
& 0x3f];
2031 if (char_count
!= 0) {
2032 bits
<<= 16 - (8 * char_count
);
2033 result
[out_cnt
++] = b64
[bits
>> 18];
2034 result
[out_cnt
++] = b64
[(bits
>> 12) & 0x3f];
2035 if (char_count
== 1) {
2036 result
[out_cnt
++] = '=';
2037 result
[out_cnt
++] = '=';
2039 result
[out_cnt
++] = b64
[(bits
>> 6) & 0x3f];
2040 result
[out_cnt
++] = '=';
2043 result
[out_cnt
] = '\0'; /* terminate */
2047 /* read a SMB_BIG_UINT from a string */
2048 SMB_BIG_UINT
STR_TO_SMB_BIG_UINT(const char *nptr
, const char **entptr
)
2051 SMB_BIG_UINT val
= -1;
2052 const char *p
= nptr
;
2054 while (p
&& *p
&& isspace(*p
))
2056 #ifdef LARGE_SMB_OFF_T
2057 sscanf(p
,"%llu",&val
);
2058 #else /* LARGE_SMB_OFF_T */
2059 sscanf(p
,"%lu",&val
);
2060 #endif /* LARGE_SMB_OFF_T */
2062 while (p
&& *p
&& isdigit(*p
))
2070 void string_append(char **left
, const char *right
)
2072 int new_len
= strlen(right
) + 1;
2074 if (*left
== NULL
) {
2075 *left
= malloc(new_len
);
2078 new_len
+= strlen(*left
);
2079 *left
= Realloc(*left
, new_len
);
2085 safe_strcat(*left
, right
, new_len
-1);