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++) upcase_table[i] = i;
55 for (i=0;i<256;i++) upcase_table[UCS2_CHAR(i)] = UCS2_CHAR(islower(i)?toupper(i):i);
59 DEBUG(1,("creating lame lowcase table\n"));
60 lowcase_table = malloc(0x20000);
61 for (i=0;i<0x10000;i++) lowcase_table[i] = i;
62 for (i=0;i<256;i++) lowcase_table[UCS2_CHAR(i)] = UCS2_CHAR(isupper(i)?tolower(i):i);
67 see if a ucs2 character can be mapped correctly to a dos character
68 and mapped back to the same character in ucs2
70 static int check_dos_char(smb_ucs2_t c)
75 len1 = convert_string(CH_UCS2, CH_DOS, &c, 2, buf, sizeof(buf));
76 if (len1 == 0) return 0;
77 len2 = convert_string(CH_DOS, CH_UCS2, buf, len1, &c2, 2);
78 if (len2 != 2) return 0;
82 /*******************************************************************
83 load the valid character map table
84 ********************************************************************/
85 void init_valid_table(void)
87 static int initialised;
88 static int mapped_file;
90 const char *allowed = ".!#$%&'()_-@^`~";
92 if (initialised && mapped_file) return;
95 valid_table = map_file(lib_path("valid.dat"), 0x10000);
101 if (valid_table) free(valid_table);
103 DEBUG(2,("creating default valid table\n"));
104 valid_table = malloc(0x10000);
105 for (i=0;i<128;i++) valid_table[UCS2_CHAR(i)] = isalnum(i) ||
107 for (;i<0x10000;i++) {
110 valid_table[c] = check_dos_char(c);
115 /*******************************************************************
116 Write a string in (little-endian) unicode format. src is in
117 the current DOS codepage. len is the length in bytes of the
118 string pointed to by dst.
120 if null_terminate is True then null terminate the packet (adds 2 bytes)
122 the return value is the length in bytes consumed by the string, including the
123 null termination if applied
124 ********************************************************************/
126 size_t dos_PutUniCode(char *dst,const char *src, ssize_t len, BOOL null_terminate)
128 return push_ucs2(NULL, dst, src, len,
129 STR_UNICODE|STR_NOALIGN | (null_terminate?STR_TERMINATE:0));
133 /*******************************************************************
134 Skip past a unicode string, but not more than len. Always move
135 past a terminating zero if found.
136 ********************************************************************/
138 char *skip_unibuf(char *src, size_t len)
140 char *srcend = src + len;
142 while (src < srcend && SVAL(src,0))
151 /* Copy a string from little-endian or big-endian unicode source (depending
152 * on flags) to internal samba format destination
154 int rpcstr_pull(char* dest, void *src, int dest_len, int src_len, int flags)
156 if(dest_len==-1) dest_len=MAXUNI-3;
157 return pull_ucs2(NULL, dest, src, dest_len, src_len, flags|STR_UNICODE|STR_NOALIGN);
160 /* Copy a string from a unistr2 source to internal samba format
161 destination. Use this instead of direct calls to rpcstr_pull() to avoid
162 having to determine whether the source string is null terminated. */
164 int rpcstr_pull_unistr2_fstring(char *dest, UNISTR2 *src)
166 return pull_ucs2(NULL, dest, src->buffer, sizeof(fstring),
167 src->uni_str_len * 2, 0);
170 /* Converts a string from internal samba format to unicode
172 int rpcstr_push(void* dest, const char *src, int dest_len, int flags)
174 return push_ucs2(NULL, dest, src, dest_len, flags|STR_UNICODE|STR_NOALIGN);
177 /*******************************************************************
178 Return a DOS codepage version of a little-endian unicode string.
179 len is the filename length (ignoring any terminating zero) in uin16
180 units. Always null terminates.
181 Hack alert: uses fixed buffer(s).
182 ********************************************************************/
183 char *dos_unistrn2(const uint16 *src, int len)
185 static char lbufs[8][MAXUNI];
187 char *lbuf = lbufs[nexti];
189 pull_ucs2(NULL, lbuf, src, MAXUNI-3, len*2, STR_NOALIGN);
193 /*******************************************************************
194 Convert a (little-endian) UNISTR2 structure to an ASCII string
195 ********************************************************************/
196 void unistr2_to_ascii(char *dest, const UNISTR2 *str, size_t maxlen)
202 pull_ucs2(NULL, dest, str->buffer, maxlen, str->uni_str_len*2, STR_NOALIGN);
206 /*******************************************************************
207 duplicate a UNISTR2 string into a null terminated char*
208 using a talloc context
209 ********************************************************************/
210 char *unistr2_tdup(TALLOC_CTX *ctx, const UNISTR2 *str)
213 int maxlen = (str->uni_str_len+1)*4;
214 if (!str->buffer) return NULL;
215 s = (char *)talloc(ctx, maxlen); /* convervative */
217 pull_ucs2(NULL, s, str->buffer, maxlen, str->uni_str_len*2,
223 /*******************************************************************
224 Return a number stored in a buffer
225 ********************************************************************/
227 uint32 buffer2_to_uint32(BUFFER2 *str)
229 if (str->buf_len == 4)
230 return IVAL(str->buffer, 0);
235 /*******************************************************************
236 Convert a wchar to upper case.
237 ********************************************************************/
239 smb_ucs2_t toupper_w(smb_ucs2_t val)
241 return upcase_table[val];
244 /*******************************************************************
245 Convert a wchar to lower case.
246 ********************************************************************/
248 smb_ucs2_t tolower_w( smb_ucs2_t val )
250 return lowcase_table[val];
253 /*******************************************************************
254 determine if a character is lowercase
255 ********************************************************************/
256 BOOL islower_w(smb_ucs2_t c)
258 return upcase_table[c] != c;
261 /*******************************************************************
262 determine if a character is uppercase
263 ********************************************************************/
264 BOOL isupper_w(smb_ucs2_t c)
266 return lowcase_table[c] != c;
270 /*******************************************************************
271 determine if a character is valid in a 8.3 name
272 ********************************************************************/
273 BOOL isvalid83_w(smb_ucs2_t c)
275 return valid_table[c] != 0;
278 /*******************************************************************
279 Count the number of characters in a smb_ucs2_t string.
280 ********************************************************************/
281 size_t strlen_w(const smb_ucs2_t *src)
285 for(len = 0; *src++; len++) ;
290 /*******************************************************************
291 Count up to max number of characters in a smb_ucs2_t string.
292 ********************************************************************/
293 size_t strnlen_w(const smb_ucs2_t *src, size_t max)
297 for(len = 0; *src++ && (len < max); len++) ;
302 /*******************************************************************
304 ********************************************************************/
305 smb_ucs2_t *strchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
308 if (c == *s) return (smb_ucs2_t *)s;
314 smb_ucs2_t *strchr_wa(const smb_ucs2_t *s, char c)
316 return strchr_w(s, UCS2_CHAR(c));
319 smb_ucs2_t *strrchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
321 const smb_ucs2_t *p = s;
322 int len = strlen_w(s);
323 if (len == 0) return NULL;
326 if (c == *p) return (smb_ucs2_t *)p;
331 /*******************************************************************
333 ********************************************************************/
334 smb_ucs2_t *strstr_w(const smb_ucs2_t *s, const smb_ucs2_t *ins)
339 if (!s || !*s || !ins || !*ins) return NULL;
341 inslen = strlen_w(ins);
343 while ((r = strchr_w(r, *ins))) {
344 if (strncmp_w(r, ins, inslen) == 0) return r;
350 /*******************************************************************
351 Convert a string to lower case.
352 return True if any char is converted
353 ********************************************************************/
354 BOOL strlower_w(smb_ucs2_t *s)
358 smb_ucs2_t v = tolower_w(*s);
368 /*******************************************************************
369 Convert a string to upper case.
370 return True if any char is converted
371 ********************************************************************/
372 BOOL strupper_w(smb_ucs2_t *s)
376 smb_ucs2_t v = toupper_w(*s);
386 /*******************************************************************
387 convert a string to "normal" form
388 ********************************************************************/
389 void strnorm_w(smb_ucs2_t *s)
391 extern int case_default;
392 if (case_default == CASE_UPPER)
398 int strcmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
400 while (*b && *a == *b) { a++; b++; }
402 /* warning: if *a != *b and both are not 0 we retrun a random
403 greater or lesser than 0 number not realted to which
407 int strncmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
410 while ((n < len) && *b && *a == *b) { a++; b++; n++;}
411 return (len - n)?(*a - *b):0;
414 /*******************************************************************
415 case insensitive string comparison
416 ********************************************************************/
417 int strcasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
419 while (*b && toupper_w(*a) == toupper_w(*b)) { a++; b++; }
420 return (tolower_w(*a) - tolower_w(*b));
423 /*******************************************************************
424 case insensitive string comparison, lenght limited
425 ********************************************************************/
426 int strncasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
429 while ((n < len) && *b && (toupper_w(*a) == toupper_w(*b))) { a++; b++; n++; }
430 return (len - n)?(tolower_w(*a) - tolower_w(*b)):0;
433 /*******************************************************************
435 ********************************************************************/
436 BOOL strequal_w(const smb_ucs2_t *s1, const smb_ucs2_t *s2)
438 if (s1 == s2) return(True);
439 if (!s1 || !s2) return(False);
441 return(strcasecmp_w(s1,s2)==0);
444 /*******************************************************************
445 compare 2 strings up to and including the nth char.
446 ******************************************************************/
447 BOOL strnequal_w(const smb_ucs2_t *s1,const smb_ucs2_t *s2,size_t n)
449 if (s1 == s2) return(True);
450 if (!s1 || !s2 || !n) return(False);
452 return(strncasecmp_w(s1,s2,n)==0);
455 /*******************************************************************
457 ********************************************************************/
458 smb_ucs2_t *strdup_w(const smb_ucs2_t *src)
460 return strndup_w(src, 0);
463 /* if len == 0 then duplicate the whole string */
464 smb_ucs2_t *strndup_w(const smb_ucs2_t *src, size_t len)
468 if (!len) len = strlen_w(src);
469 dest = (smb_ucs2_t *)malloc((len + 1) * sizeof(smb_ucs2_t));
471 DEBUG(0,("strdup_w: out of memory!\n"));
475 memcpy(dest, src, len * sizeof(smb_ucs2_t));
481 /*******************************************************************
482 copy a string with max len
483 ********************************************************************/
485 smb_ucs2_t *strncpy_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
489 if (!dest || !src) return NULL;
491 for (len = 0; (src[len] != 0) && (len < max); len++)
492 dest[len] = src[len];
500 /*******************************************************************
501 append a string of len bytes and add a terminator
502 ********************************************************************/
504 smb_ucs2_t *strncat_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
509 if (!dest || !src) return NULL;
511 start = strlen_w(dest);
512 len = strnlen_w(src, max);
514 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
520 smb_ucs2_t *strcat_w(smb_ucs2_t *dest, const smb_ucs2_t *src)
525 if (!dest || !src) return NULL;
527 start = strlen_w(dest);
530 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
537 /*******************************************************************
538 replace any occurence of oldc with newc in unicode string
539 ********************************************************************/
541 void string_replace_w(smb_ucs2_t *s, smb_ucs2_t oldc, smb_ucs2_t newc)
544 if(*s==oldc) *s=newc;
548 /*******************************************************************
550 ********************************************************************/
552 BOOL trim_string_w(smb_ucs2_t *s, const smb_ucs2_t *front,
553 const smb_ucs2_t *back)
556 size_t len, front_len, back_len;
558 if (!s || !*s) return False;
562 if (front && *front) {
563 front_len = strlen_w(front);
564 while (len && strncmp_w(s, front, front_len) == 0) {
565 memmove(s, (s + front_len), (len - front_len + 1) * sizeof(smb_ucs2_t));
572 back_len = strlen_w(back);
573 while (len && strncmp_w((s + (len - back_len)), back, back_len) == 0) {
574 s[len - back_len] = 0;
584 The *_wa() functions take a combination of 7 bit ascii
585 and wide characters They are used so that you can use string
586 functions combining C string constants with ucs2 strings
588 The char* arguments must NOT be multibyte - to be completely sure
589 of this only pass string constants */
592 void pstrcpy_wa(smb_ucs2_t *dest, const char *src)
595 for (i=0;i<PSTRING_LEN;i++) {
596 dest[i] = UCS2_CHAR(src[i]);
597 if (src[i] == 0) return;
601 int strcmp_wa(const smb_ucs2_t *a, const char *b)
603 while (*b && *a == UCS2_CHAR(*b)) { a++; b++; }
604 return (*a - UCS2_CHAR(*b));
607 int strncmp_wa(const smb_ucs2_t *a, const char *b, size_t len)
610 while ((n < len) && *b && *a == UCS2_CHAR(*b)) { a++; b++; n++;}
611 return (len - n)?(*a - UCS2_CHAR(*b)):0;
614 smb_ucs2_t *strpbrk_wa(const smb_ucs2_t *s, const char *p)
618 for (i=0; p[i] && *s != UCS2_CHAR(p[i]); i++)
620 if (p[i]) return (smb_ucs2_t *)s;
626 smb_ucs2_t *strstr_wa(const smb_ucs2_t *s, const char *ins)
631 if (!s || !*s || !ins || !*ins) return NULL;
633 inslen = strlen(ins);
635 while ((r = strchr_w(r, UCS2_CHAR(*ins)))) {
636 if (strncmp_wa(r, ins, inslen) == 0) return r;
642 /*******************************************************************
643 copy a string with max len
644 ********************************************************************/
646 smb_ucs2_t *strncpy_wa(smb_ucs2_t *dest, const char *src, const size_t max)
648 smb_ucs2_t *ucs2_src;
650 if (!dest || !src) return NULL;
651 if (!(ucs2_src = acnv_uxu2(src)))
654 strncpy_w(dest, ucs2_src, max);
659 /*******************************************************************
660 convert and duplicate an ascii string
661 ********************************************************************/
662 smb_ucs2_t *strdup_wa(const char *src)
664 return strndup_wa(src, 0);
667 /* if len == 0 then duplicate the whole string */
668 smb_ucs2_t *strndup_wa(const char *src, size_t len)
670 smb_ucs2_t *dest, *s;
673 if (!len) len = strlen_w(s);
674 dest = (smb_ucs2_t *)malloc((len + 1) * sizeof(smb_ucs2_t));
676 DEBUG(0,("strdup_w: out of memory!\n"));
681 memcpy(dest, src, len * sizeof(smb_ucs2_t));
688 /*******************************************************************
689 append a string of len bytes and add a terminator
690 ********************************************************************/
692 smb_ucs2_t *strncat_wa(smb_ucs2_t *dest, const char *src, const size_t max)
694 smb_ucs2_t *ucs2_src;
696 if (!dest || !src) return NULL;
697 if (!(ucs2_src = acnv_uxu2(src)))
700 strncat_w(dest, ucs2_src, max);
705 smb_ucs2_t *strcat_wa(smb_ucs2_t *dest, const char *src)
707 smb_ucs2_t *ucs2_src;
709 if (!dest || !src) return NULL;
710 if (!(ucs2_src = acnv_uxu2(src)))
713 strcat_w(dest, ucs2_src);
718 BOOL trim_string_wa(smb_ucs2_t *s, const char *front,
723 if (front) push_ucs2(NULL, f, front, sizeof(wpstring) - 1, STR_TERMINATE);
725 if (back) push_ucs2(NULL, b, back, sizeof(wpstring) - 1, STR_TERMINATE);
727 return trim_string_w(s, f, b);