2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-2001
5 Copyright (C) Simo Sorce 2001
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 /* these 3 tables define the unicode case handling. They are loaded
29 at startup either via mmap() or read() from the lib directory */
30 static smb_ucs2_t *upcase_table;
31 static smb_ucs2_t *lowcase_table;
32 static uint8 *valid_table;
35 /*******************************************************************
36 load the case handling tables
37 ********************************************************************/
38 void load_case_tables(void)
40 static int initialised;
43 if (initialised) return;
46 upcase_table = map_file(lib_path("upcase.dat"), 0x20000);
47 lowcase_table = map_file(lib_path("lowcase.dat"), 0x20000);
49 /* we would like Samba to limp along even if these tables are
52 DEBUG(1,("creating lame upcase table\n"));
53 upcase_table = malloc(0x20000);
54 for (i=0;i<0x10000;i++) {
61 SSVAL(&v, 0, UCS2_CHAR(i));
62 upcase_table[v] = UCS2_CHAR(islower(i)?toupper(i):i);
67 DEBUG(1,("creating lame lowcase table\n"));
68 lowcase_table = malloc(0x20000);
69 for (i=0;i<0x10000;i++) {
76 SSVAL(&v, 0, UCS2_CHAR(i));
77 lowcase_table[v] = UCS2_CHAR(isupper(i)?tolower(i):i);
83 see if a ucs2 character can be mapped correctly to a dos character
84 and mapped back to the same character in ucs2
86 static int check_dos_char(smb_ucs2_t c)
91 len1 = convert_string(CH_UCS2, CH_DOS, &c, 2, buf, sizeof(buf));
92 if (len1 == 0) return 0;
93 len2 = convert_string(CH_DOS, CH_UCS2, buf, len1, &c2, 2);
94 if (len2 != 2) return 0;
99 * Load the valid character map table from <tt>valid.dat</tt> or
100 * create from the configured codepage.
102 * This function is called whenever the configuration is reloaded.
103 * However, the valid character table is not changed if it's loaded
104 * from a file, because we can't unmap files.
106 void init_valid_table(void)
108 static int initialised;
109 static int mapped_file;
111 const char *allowed = ".!#$%&'()_-@^`~";
113 if (initialised && mapped_file) return;
116 valid_table = map_file(lib_path("valid.dat"), 0x10000);
122 /* Otherwise, using a dynamically loaded one. */
123 if (valid_table) free(valid_table);
125 DEBUG(2,("creating default valid table\n"));
126 valid_table = malloc(0x10000);
127 for (i=0;i<128;i++) valid_table[i] = isalnum(i) ||
129 for (;i<0x10000;i++) {
132 valid_table[i] = check_dos_char(c);
138 /*******************************************************************
139 Write a string in (little-endian) unicode format. src is in
140 the current DOS codepage. len is the length in bytes of the
141 string pointed to by dst.
143 if null_terminate is True then null terminate the packet (adds 2 bytes)
145 the return value is the length in bytes consumed by the string, including the
146 null termination if applied
147 ********************************************************************/
149 size_t dos_PutUniCode(char *dst,const char *src, ssize_t len, BOOL null_terminate)
151 return push_ucs2(NULL, dst, src, len,
152 STR_UNICODE|STR_NOALIGN | (null_terminate?STR_TERMINATE:0));
156 /*******************************************************************
157 Skip past a unicode string, but not more than len. Always move
158 past a terminating zero if found.
159 ********************************************************************/
161 char *skip_unibuf(char *src, size_t len)
163 char *srcend = src + len;
165 while (src < srcend && SVAL(src,0))
174 /* Copy a string from little-endian or big-endian unicode source (depending
175 * on flags) to internal samba format destination
177 int rpcstr_pull(char* dest, void *src, int dest_len, int src_len, int flags)
180 if(dest_len==-1) dest_len=MAXUNI-3;
181 return pull_ucs2(NULL, dest, src, dest_len, src_len, flags|STR_UNICODE|STR_NOALIGN);
184 /* Copy a string from a unistr2 source to internal samba format
185 destination. Use this instead of direct calls to rpcstr_pull() to avoid
186 having to determine whether the source string is null terminated. */
188 int rpcstr_pull_unistr2_fstring(char *dest, UNISTR2 *src)
190 return pull_ucs2(NULL, dest, src->buffer, sizeof(fstring),
191 src->uni_str_len * 2, 0);
194 /* Converts a string from internal samba format to unicode
196 int rpcstr_push(void* dest, const char *src, int dest_len, int flags)
198 return push_ucs2(NULL, dest, src, dest_len, flags|STR_UNICODE|STR_NOALIGN);
201 /*******************************************************************
202 Return a DOS codepage version of a little-endian unicode string.
203 len is the filename length (ignoring any terminating zero) in uin16
204 units. Always null terminates.
205 Hack alert: uses fixed buffer(s).
206 ********************************************************************/
207 char *dos_unistrn2(const uint16 *src, int len)
209 static char lbufs[8][MAXUNI];
211 char *lbuf = lbufs[nexti];
213 pull_ucs2(NULL, lbuf, src, MAXUNI-3, len*2, STR_NOALIGN);
217 /*******************************************************************
218 Convert a (little-endian) UNISTR2 structure to an ASCII string
219 ********************************************************************/
220 void unistr2_to_ascii(char *dest, const UNISTR2 *str, size_t maxlen)
226 pull_ucs2(NULL, dest, str->buffer, maxlen, str->uni_str_len*2, STR_NOALIGN);
229 /*******************************************************************
230 give a static string for displaying a UNISTR2
231 ********************************************************************/
232 const char *unistr2_static(const UNISTR2 *str)
235 unistr2_to_ascii(ret, str, sizeof(ret));
240 /*******************************************************************
241 duplicate a UNISTR2 string into a null terminated char*
242 using a talloc context
243 ********************************************************************/
244 char *unistr2_tdup(TALLOC_CTX *ctx, const UNISTR2 *str)
247 int maxlen = (str->uni_str_len+1)*4;
248 if (!str->buffer) return NULL;
249 s = (char *)talloc(ctx, maxlen); /* convervative */
251 pull_ucs2(NULL, s, str->buffer, maxlen, str->uni_str_len*2,
257 /*******************************************************************
258 Return a number stored in a buffer
259 ********************************************************************/
261 uint32 buffer2_to_uint32(BUFFER2 *str)
263 if (str->buf_len == 4)
264 return IVAL(str->buffer, 0);
269 /*******************************************************************
270 Convert a wchar to upper case.
271 ********************************************************************/
273 smb_ucs2_t toupper_w(smb_ucs2_t val)
275 return upcase_table[SVAL(&val,0)];
278 /*******************************************************************
279 Convert a wchar to lower case.
280 ********************************************************************/
282 smb_ucs2_t tolower_w( smb_ucs2_t val )
284 return lowcase_table[SVAL(&val,0)];
288 /*******************************************************************
289 determine if a character is lowercase
290 ********************************************************************/
291 BOOL islower_w(smb_ucs2_t c)
293 return upcase_table[SVAL(&c,0)] != c;
296 /*******************************************************************
297 determine if a character is uppercase
298 ********************************************************************/
299 BOOL isupper_w(smb_ucs2_t c)
301 return lowcase_table[SVAL(&c,0)] != c;
305 /*******************************************************************
306 determine if a character is valid in a 8.3 name
307 ********************************************************************/
308 BOOL isvalid83_w(smb_ucs2_t c)
310 return valid_table[SVAL(&c,0)] != 0;
313 /*******************************************************************
314 Count the number of characters in a smb_ucs2_t string.
315 ********************************************************************/
316 size_t strlen_w(const smb_ucs2_t *src)
320 for(len = 0; *src++; len++) ;
325 /*******************************************************************
326 Count up to max number of characters in a smb_ucs2_t string.
327 ********************************************************************/
328 size_t strnlen_w(const smb_ucs2_t *src, size_t max)
332 for(len = 0; *src++ && (len < max); len++) ;
337 /*******************************************************************
339 ********************************************************************/
340 smb_ucs2_t *strchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
343 if (c == *s) return (smb_ucs2_t *)s;
346 if (c == *s) return (smb_ucs2_t *)s;
351 smb_ucs2_t *strchr_wa(const smb_ucs2_t *s, char c)
353 return strchr_w(s, UCS2_CHAR(c));
356 smb_ucs2_t *strrchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
358 const smb_ucs2_t *p = s;
359 int len = strlen_w(s);
360 if (len == 0) return NULL;
363 if (c == *p) return (smb_ucs2_t *)p;
368 /*******************************************************************
370 ********************************************************************/
371 smb_ucs2_t *strstr_w(const smb_ucs2_t *s, const smb_ucs2_t *ins)
376 if (!s || !*s || !ins || !*ins) return NULL;
378 inslen = strlen_w(ins);
380 while ((r = strchr_w(r, *ins))) {
381 if (strncmp_w(r, ins, inslen) == 0) return r;
387 /*******************************************************************
388 Convert a string to lower case.
389 return True if any char is converted
390 ********************************************************************/
391 BOOL strlower_w(smb_ucs2_t *s)
395 smb_ucs2_t v = tolower_w(*s);
405 /*******************************************************************
406 Convert a string to upper case.
407 return True if any char is converted
408 ********************************************************************/
409 BOOL strupper_w(smb_ucs2_t *s)
413 smb_ucs2_t v = toupper_w(*s);
423 /*******************************************************************
424 convert a string to "normal" form
425 ********************************************************************/
426 void strnorm_w(smb_ucs2_t *s)
428 extern int case_default;
429 if (case_default == CASE_UPPER)
435 int strcmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
437 while (*b && *a == *b) { a++; b++; }
439 /* warning: if *a != *b and both are not 0 we retrun a random
440 greater or lesser than 0 number not realted to which
444 int strncmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
447 while ((n < len) && *b && *a == *b) { a++; b++; n++;}
448 return (len - n)?(*a - *b):0;
451 /*******************************************************************
452 case insensitive string comparison
453 ********************************************************************/
454 int strcasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
456 while (*b && toupper_w(*a) == toupper_w(*b)) { a++; b++; }
457 return (tolower_w(*a) - tolower_w(*b));
460 /*******************************************************************
461 case insensitive string comparison, lenght limited
462 ********************************************************************/
463 int strncasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
466 while ((n < len) && *b && (toupper_w(*a) == toupper_w(*b))) { a++; b++; n++; }
467 return (len - n)?(tolower_w(*a) - tolower_w(*b)):0;
470 /*******************************************************************
472 ********************************************************************/
473 BOOL strequal_w(const smb_ucs2_t *s1, const smb_ucs2_t *s2)
475 if (s1 == s2) return(True);
476 if (!s1 || !s2) return(False);
478 return(strcasecmp_w(s1,s2)==0);
481 /*******************************************************************
482 compare 2 strings up to and including the nth char.
483 ******************************************************************/
484 BOOL strnequal_w(const smb_ucs2_t *s1,const smb_ucs2_t *s2,size_t n)
486 if (s1 == s2) return(True);
487 if (!s1 || !s2 || !n) return(False);
489 return(strncasecmp_w(s1,s2,n)==0);
492 /*******************************************************************
494 ********************************************************************/
495 smb_ucs2_t *strdup_w(const smb_ucs2_t *src)
497 return strndup_w(src, 0);
500 /* if len == 0 then duplicate the whole string */
501 smb_ucs2_t *strndup_w(const smb_ucs2_t *src, size_t len)
505 if (!len) len = strlen_w(src);
506 dest = (smb_ucs2_t *)malloc((len + 1) * sizeof(smb_ucs2_t));
508 DEBUG(0,("strdup_w: out of memory!\n"));
512 memcpy(dest, src, len * sizeof(smb_ucs2_t));
518 /*******************************************************************
519 copy a string with max len
520 ********************************************************************/
522 smb_ucs2_t *strncpy_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
526 if (!dest || !src) return NULL;
528 for (len = 0; (src[len] != 0) && (len < max); len++)
529 dest[len] = src[len];
537 /*******************************************************************
538 append a string of len bytes and add a terminator
539 ********************************************************************/
541 smb_ucs2_t *strncat_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
546 if (!dest || !src) return NULL;
548 start = strlen_w(dest);
549 len = strnlen_w(src, max);
551 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
557 smb_ucs2_t *strcat_w(smb_ucs2_t *dest, const smb_ucs2_t *src)
562 if (!dest || !src) return NULL;
564 start = strlen_w(dest);
567 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
574 /*******************************************************************
575 replace any occurence of oldc with newc in unicode string
576 ********************************************************************/
578 void string_replace_w(smb_ucs2_t *s, smb_ucs2_t oldc, smb_ucs2_t newc)
581 if(*s==oldc) *s=newc;
585 /*******************************************************************
587 ********************************************************************/
589 BOOL trim_string_w(smb_ucs2_t *s, const smb_ucs2_t *front,
590 const smb_ucs2_t *back)
593 size_t len, front_len, back_len;
595 if (!s || !*s) return False;
599 if (front && *front) {
600 front_len = strlen_w(front);
601 while (len && strncmp_w(s, front, front_len) == 0) {
602 memmove(s, (s + front_len), (len - front_len + 1) * sizeof(smb_ucs2_t));
609 back_len = strlen_w(back);
610 while (len && strncmp_w((s + (len - back_len)), back, back_len) == 0) {
611 s[len - back_len] = 0;
621 The *_wa() functions take a combination of 7 bit ascii
622 and wide characters They are used so that you can use string
623 functions combining C string constants with ucs2 strings
625 The char* arguments must NOT be multibyte - to be completely sure
626 of this only pass string constants */
629 void pstrcpy_wa(smb_ucs2_t *dest, const char *src)
632 for (i=0;i<PSTRING_LEN;i++) {
633 dest[i] = UCS2_CHAR(src[i]);
634 if (src[i] == 0) return;
638 int strcmp_wa(const smb_ucs2_t *a, const char *b)
640 while (*b && *a == UCS2_CHAR(*b)) { a++; b++; }
641 return (*a - UCS2_CHAR(*b));
644 int strncmp_wa(const smb_ucs2_t *a, const char *b, size_t len)
647 while ((n < len) && *b && *a == UCS2_CHAR(*b)) { a++; b++; n++;}
648 return (len - n)?(*a - UCS2_CHAR(*b)):0;
651 smb_ucs2_t *strpbrk_wa(const smb_ucs2_t *s, const char *p)
655 for (i=0; p[i] && *s != UCS2_CHAR(p[i]); i++)
657 if (p[i]) return (smb_ucs2_t *)s;
663 smb_ucs2_t *strstr_wa(const smb_ucs2_t *s, const char *ins)
668 if (!s || !*s || !ins || !*ins) return NULL;
670 inslen = strlen(ins);
672 while ((r = strchr_w(r, UCS2_CHAR(*ins)))) {
673 if (strncmp_wa(r, ins, inslen) == 0) return r;
679 /*******************************************************************
680 copy a string with max len
681 ********************************************************************/
683 smb_ucs2_t *strncpy_wa(smb_ucs2_t *dest, const char *src, const size_t max)
685 smb_ucs2_t *ucs2_src;
687 if (!dest || !src) return NULL;
688 if (!(ucs2_src = acnv_uxu2(src)))
691 strncpy_w(dest, ucs2_src, max);
696 /*******************************************************************
697 convert and duplicate an ascii string
698 ********************************************************************/
699 smb_ucs2_t *strdup_wa(const char *src)
701 return strndup_wa(src, 0);
704 /* if len == 0 then duplicate the whole string */
705 smb_ucs2_t *strndup_wa(const char *src, size_t len)
707 smb_ucs2_t *dest, *s;
710 if (!len) len = strlen_w(s);
711 dest = (smb_ucs2_t *)malloc((len + 1) * sizeof(smb_ucs2_t));
713 DEBUG(0,("strdup_w: out of memory!\n"));
718 memcpy(dest, src, len * sizeof(smb_ucs2_t));
725 /*******************************************************************
726 append a string of len bytes and add a terminator
727 ********************************************************************/
729 smb_ucs2_t *strncat_wa(smb_ucs2_t *dest, const char *src, const size_t max)
731 smb_ucs2_t *ucs2_src;
733 if (!dest || !src) return NULL;
734 if (!(ucs2_src = acnv_uxu2(src)))
737 strncat_w(dest, ucs2_src, max);
742 smb_ucs2_t *strcat_wa(smb_ucs2_t *dest, const char *src)
744 smb_ucs2_t *ucs2_src;
746 if (!dest || !src) return NULL;
747 if (!(ucs2_src = acnv_uxu2(src)))
750 strcat_w(dest, ucs2_src);
755 BOOL trim_string_wa(smb_ucs2_t *s, const char *front,
760 if (front) push_ucs2(NULL, f, front, sizeof(wpstring) - 1, STR_TERMINATE);
762 if (back) push_ucs2(NULL, b, back, sizeof(wpstring) - 1, STR_TERMINATE);
764 return trim_string_w(s, f, b);
767 /*******************************************************************
768 returns the length in number of wide characters
769 ******************************************************************/
770 int unistrlen(uint16 *s)
777 for (len=0; *s; s++,len++);
782 /*******************************************************************
783 Strcpy for unicode strings. returns length (in num of wide chars)
784 ********************************************************************/
786 int unistrcpy(uint16 *dst, uint16 *src)
800 * Samba ucs2 type to UNISTR2 conversion
802 * @param ctx Talloc context to create the dst strcture (if null) and the
803 * contents of the unicode string.
804 * @param dst UNISTR2 destination. If equals null, then it's allocated.
805 * @param src smb_ucs2_t source.
806 * @param max_len maximum number of unicode characters to copy. If equals
807 * null, then null-termination of src is taken
809 * @return copied UNISTR2 destination
811 UNISTR2* ucs2_to_unistr2(TALLOC_CTX *ctx, UNISTR2* dst, smb_ucs2_t* src)
815 if (!src) return NULL;
818 /* allocate UNISTR2 destination if not given */
820 dst = (UNISTR2*) talloc(ctx, sizeof(UNISTR2));
821 if (!dst) return NULL;
824 dst->buffer = (uint16*) talloc(ctx, sizeof(uint16) * (len + 1));
825 if (!dst->buffer) return NULL;
828 /* set UNISTR2 parameters */
829 dst->uni_max_len = len + 1;
831 dst->uni_str_len = len;
833 /* copy the actual unicode string */
834 strncpy_w(dst->buffer, src, dst->uni_max_len);