2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-2001
5 Copyright (C) Simo Sorce 2001
6 Copyright (C) Jeremy Allison 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
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;
33 static bool upcase_table_use_unmap;
34 static bool lowcase_table_use_unmap;
35 static bool valid_table_use_unmap;
36 static bool initialized;
39 * Destroy global objects allocated by load_case_tables()
41 void gfree_case_tables(void)
44 if ( upcase_table_use_unmap )
45 unmap_file(upcase_table, 0x20000);
47 SAFE_FREE(upcase_table);
50 if ( lowcase_table ) {
51 if ( lowcase_table_use_unmap )
52 unmap_file(lowcase_table, 0x20000);
54 SAFE_FREE(lowcase_table);
58 if ( valid_table_use_unmap )
59 unmap_file(valid_table, 0x10000);
61 SAFE_FREE(valid_table);
67 * Load or generate the case handling tables.
69 * The case tables are defined in UCS2 and don't depend on any
70 * configured parameters, so they never need to be reloaded.
73 void load_case_tables(void)
75 char *old_locale = NULL, *saved_locale = NULL;
77 TALLOC_CTX *frame = NULL;
84 frame = talloc_stackframe();
86 upcase_table = (smb_ucs2_t *)map_file(data_path("upcase.dat"),
88 upcase_table_use_unmap = ( upcase_table != NULL );
90 lowcase_table = (smb_ucs2_t *)map_file(data_path("lowcase.dat"),
92 lowcase_table_use_unmap = ( lowcase_table != NULL );
95 /* Get the name of the current locale. */
96 old_locale = setlocale(LC_ALL, NULL);
99 /* Save it as it is in static storage. */
100 saved_locale = SMB_STRDUP(old_locale);
103 /* We set back the locale to C to get ASCII-compatible toupper/lower functions. */
104 setlocale(LC_ALL, "C");
107 /* we would like Samba to limp along even if these tables are
110 DEBUG(1,("creating lame upcase table\n"));
111 upcase_table = (smb_ucs2_t *)SMB_MALLOC(0x20000);
112 for (i=0;i<0x10000;i++) {
117 for (i=0;i<256;i++) {
119 SSVAL(&v, 0, UCS2_CHAR(i));
120 upcase_table[v] = UCS2_CHAR(islower(i)?toupper(i):i);
124 if (!lowcase_table) {
125 DEBUG(1,("creating lame lowcase table\n"));
126 lowcase_table = (smb_ucs2_t *)SMB_MALLOC(0x20000);
127 for (i=0;i<0x10000;i++) {
130 lowcase_table[v] = i;
132 for (i=0;i<256;i++) {
134 SSVAL(&v, 0, UCS2_CHAR(i));
135 lowcase_table[v] = UCS2_CHAR(isupper(i)?tolower(i):i);
139 #ifdef HAVE_SETLOCALE
140 /* Restore the old locale. */
142 setlocale (LC_ALL, saved_locale);
143 SAFE_FREE(saved_locale);
149 static int check_dos_char_slowly(smb_ucs2_t c)
155 len1 = convert_string(CH_UTF16LE, CH_DOS, &c, 2, buf, sizeof(buf),False);
159 len2 = convert_string(CH_DOS, CH_UTF16LE, buf, len1, &c2, 2,False);
167 * Load the valid character map table from <tt>valid.dat</tt> or
168 * create from the configured codepage.
170 * This function is called whenever the configuration is reloaded.
171 * However, the valid character table is not changed if it's loaded
172 * from a file, because we can't unmap files.
175 void init_valid_table(void)
177 static int mapped_file;
179 const char *allowed = ".!#$%&'()_-@^`~";
183 /* Can't unmap files, so stick with what we have */
187 valid_file = (uint8 *)map_file(data_path("valid.dat"), 0x10000);
189 valid_table = valid_file;
191 valid_table_use_unmap = True;
195 /* Otherwise, we're using a dynamically created valid_table.
196 * It might need to be regenerated if the code page changed.
197 * We know that we're not using a mapped file, so we can
198 * free() the old one. */
199 SAFE_FREE(valid_table);
201 /* use free rather than unmap */
202 valid_table_use_unmap = False;
204 DEBUG(2,("creating default valid table\n"));
205 valid_table = (uint8 *)SMB_MALLOC(0x10000);
206 SMB_ASSERT(valid_table != NULL);
207 for (i=0;i<128;i++) {
208 valid_table[i] = isalnum(i) || strchr(allowed,i);
211 lazy_initialize_conv();
213 for (;i<0x10000;i++) {
216 valid_table[i] = check_dos_char_slowly(c);
220 /*******************************************************************
221 Write a string in (little-endian) unicode format. src is in
222 the current DOS codepage. len is the length in bytes of the
223 string pointed to by dst.
225 if null_terminate is True then null terminate the packet (adds 2 bytes)
227 the return value is the length in bytes consumed by the string, including the
228 null termination if applied
229 ********************************************************************/
231 size_t dos_PutUniCode(char *dst,const char *src, size_t len, bool null_terminate)
233 int flags = null_terminate ? STR_UNICODE|STR_NOALIGN|STR_TERMINATE
234 : STR_UNICODE|STR_NOALIGN;
235 return push_ucs2(NULL, dst, src, len, flags);
239 /*******************************************************************
240 Skip past a unicode string, but not more than len. Always move
241 past a terminating zero if found.
242 ********************************************************************/
244 char *skip_unibuf(char *src, size_t len)
246 char *srcend = src + len;
248 while (src < srcend && SVAL(src,0)) {
259 /* Converts a string from internal samba format to unicode
262 int rpcstr_push(void *dest, const char *src, size_t dest_len, int flags)
264 return push_ucs2(NULL, dest, src, dest_len, flags|STR_UNICODE|STR_NOALIGN);
267 /* Converts a string from internal samba format to unicode. Always terminates.
268 * Actually just a wrapper round push_ucs2_talloc().
271 int rpcstr_push_talloc(TALLOC_CTX *ctx, smb_ucs2_t **dest, const char *src)
274 if (push_ucs2_talloc(ctx, dest, src, &size))
280 /*******************************************************************
281 Convert a wchar to upper case.
282 ********************************************************************/
284 smb_ucs2_t toupper_w(smb_ucs2_t val)
286 return upcase_table[SVAL(&val,0)];
289 /*******************************************************************
290 Convert a wchar to lower case.
291 ********************************************************************/
293 smb_ucs2_t tolower_w( smb_ucs2_t val )
295 return lowcase_table[SVAL(&val,0)];
298 /*******************************************************************
299 Determine if a character is lowercase.
300 ********************************************************************/
302 bool islower_w(smb_ucs2_t c)
304 return upcase_table[SVAL(&c,0)] != c;
307 /*******************************************************************
308 Determine if a character is uppercase.
309 ********************************************************************/
311 bool isupper_w(smb_ucs2_t c)
313 return lowcase_table[SVAL(&c,0)] != c;
316 /*******************************************************************
317 Determine if a character is valid in a 8.3 name.
318 ********************************************************************/
320 bool isvalid83_w(smb_ucs2_t c)
322 return valid_table[SVAL(&c,0)] != 0;
325 /*******************************************************************
326 Count the number of characters in a smb_ucs2_t string.
327 ********************************************************************/
329 size_t strlen_w(const smb_ucs2_t *src)
334 for(len = 0; *(COPY_UCS2_CHAR(&c,src)); src++, len++) {
341 /*******************************************************************
342 Count up to max number of characters in a smb_ucs2_t string.
343 ********************************************************************/
345 size_t strnlen_w(const smb_ucs2_t *src, size_t max)
350 for(len = 0; (len < max) && *(COPY_UCS2_CHAR(&c,src)); src++, len++) {
357 /*******************************************************************
359 ********************************************************************/
361 smb_ucs2_t *strchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
364 while (*(COPY_UCS2_CHAR(&cp,s))) {
366 return (smb_ucs2_t *)s;
371 return (smb_ucs2_t *)s;
377 smb_ucs2_t *strchr_wa(const smb_ucs2_t *s, char c)
379 return strchr_w(s, UCS2_CHAR(c));
382 /*******************************************************************
384 ********************************************************************/
386 smb_ucs2_t *strrchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
389 const smb_ucs2_t *p = s;
390 int len = strlen_w(s);
397 if (c == *(COPY_UCS2_CHAR(&cp,p))) {
398 return (smb_ucs2_t *)p;
404 /*******************************************************************
405 Wide version of strrchr that returns after doing strrchr 'n' times.
406 ********************************************************************/
408 smb_ucs2_t *strnrchr_w(const smb_ucs2_t *s, smb_ucs2_t c, unsigned int n)
411 const smb_ucs2_t *p = s;
412 int len = strlen_w(s);
414 if (len == 0 || !n) {
419 if (c == *(COPY_UCS2_CHAR(&cp,p))) {
424 return (smb_ucs2_t *)p;
430 /*******************************************************************
432 ********************************************************************/
434 smb_ucs2_t *strstr_w(const smb_ucs2_t *s, const smb_ucs2_t *ins)
439 if (!s || !*s || !ins || !*ins) {
443 inslen = strlen_w(ins);
446 while ((r = strchr_w(r, *ins))) {
447 if (strncmp_w(r, ins, inslen) == 0) {
456 /*******************************************************************
457 Convert a string to lower case.
458 return True if any char is converted
459 ********************************************************************/
461 bool strlower_w(smb_ucs2_t *s)
466 while (*(COPY_UCS2_CHAR(&cp,s))) {
467 smb_ucs2_t v = tolower_w(cp);
469 COPY_UCS2_CHAR(s,&v);
477 /*******************************************************************
478 Convert a string to upper case.
479 return True if any char is converted
480 ********************************************************************/
482 bool strupper_w(smb_ucs2_t *s)
486 while (*(COPY_UCS2_CHAR(&cp,s))) {
487 smb_ucs2_t v = toupper_w(cp);
489 COPY_UCS2_CHAR(s,&v);
497 /*******************************************************************
498 Convert a string to "normal" form.
499 ********************************************************************/
501 void strnorm_w(smb_ucs2_t *s, int case_default)
503 if (case_default == CASE_UPPER) {
510 int strcmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
514 while ((*(COPY_UCS2_CHAR(&cpb,b))) && (*(COPY_UCS2_CHAR(&cpa,a)) == cpb)) {
518 return (*(COPY_UCS2_CHAR(&cpa,a)) - *(COPY_UCS2_CHAR(&cpb,b)));
519 /* warning: if *a != *b and both are not 0 we return a random
520 greater or lesser than 0 number not realted to which
524 int strncmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
529 while ((n < len) && (*(COPY_UCS2_CHAR(&cpb,b))) && (*(COPY_UCS2_CHAR(&cpa,a)) == cpb)) {
534 return (len - n)?(*(COPY_UCS2_CHAR(&cpa,a)) - *(COPY_UCS2_CHAR(&cpb,b))):0;
537 /*******************************************************************
538 Case insensitive string comparison.
539 ********************************************************************/
541 int strcasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
545 while ((*COPY_UCS2_CHAR(&cpb,b)) && toupper_w(*(COPY_UCS2_CHAR(&cpa,a))) == toupper_w(cpb)) {
549 return (tolower_w(*(COPY_UCS2_CHAR(&cpa,a))) - tolower_w(*(COPY_UCS2_CHAR(&cpb,b))));
552 /*******************************************************************
553 Case insensitive string comparison, length limited.
554 ********************************************************************/
556 int strncasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
561 while ((n < len) && *COPY_UCS2_CHAR(&cpb,b) && (toupper_w(*(COPY_UCS2_CHAR(&cpa,a))) == toupper_w(cpb))) {
566 return (len - n)?(tolower_w(*(COPY_UCS2_CHAR(&cpa,a))) - tolower_w(*(COPY_UCS2_CHAR(&cpb,b)))):0;
569 /*******************************************************************
571 ********************************************************************/
573 bool strequal_w(const smb_ucs2_t *s1, const smb_ucs2_t *s2)
582 return(strcasecmp_w(s1,s2)==0);
585 /*******************************************************************
586 Compare 2 strings up to and including the nth char.
587 ******************************************************************/
589 bool strnequal_w(const smb_ucs2_t *s1,const smb_ucs2_t *s2,size_t n)
594 if (!s1 || !s2 || !n) {
598 return(strncasecmp_w(s1,s2,n)==0);
601 /*******************************************************************
603 ********************************************************************/
605 smb_ucs2_t *strdup_w(const smb_ucs2_t *src)
607 return strndup_w(src, 0);
610 /* if len == 0 then duplicate the whole string */
612 smb_ucs2_t *strndup_w(const smb_ucs2_t *src, size_t len)
619 dest = SMB_MALLOC_ARRAY(smb_ucs2_t, len + 1);
621 DEBUG(0,("strdup_w: out of memory!\n"));
625 memcpy(dest, src, len * sizeof(smb_ucs2_t));
630 /*******************************************************************
631 Copy a string with max len.
632 ********************************************************************/
634 smb_ucs2_t *strncpy_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
643 for (len = 0; (*COPY_UCS2_CHAR(&cp,(src+len))) && (len < max); len++) {
644 cp = *COPY_UCS2_CHAR(dest+len,src+len);
647 for ( /*nothing*/ ; len < max; len++ ) {
648 cp = *COPY_UCS2_CHAR(dest+len,&cp);
654 /*******************************************************************
655 Append a string of len bytes and add a terminator.
656 ********************************************************************/
658 smb_ucs2_t *strncat_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
668 start = strlen_w(dest);
669 len = strnlen_w(src, max);
671 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
672 z = *COPY_UCS2_CHAR(dest+start+len,&z);
677 smb_ucs2_t *strcat_w(smb_ucs2_t *dest, const smb_ucs2_t *src)
687 start = strlen_w(dest);
690 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
691 z = *COPY_UCS2_CHAR(dest+start+len,&z);
697 /*******************************************************************
698 Replace any occurence of oldc with newc in unicode string.
699 ********************************************************************/
701 void string_replace_w(smb_ucs2_t *s, smb_ucs2_t oldc, smb_ucs2_t newc)
705 for(;*(COPY_UCS2_CHAR(&cp,s));s++) {
707 COPY_UCS2_CHAR(s,&newc);
712 /*******************************************************************
714 ********************************************************************/
716 bool trim_string_w(smb_ucs2_t *s, const smb_ucs2_t *front,
717 const smb_ucs2_t *back)
720 size_t len, front_len, back_len;
728 if (front && *front) {
729 front_len = strlen_w(front);
730 while (len && strncmp_w(s, front, front_len) == 0) {
731 memmove(s, (s + front_len), (len - front_len + 1) * sizeof(smb_ucs2_t));
738 back_len = strlen_w(back);
739 while (len && strncmp_w((s + (len - back_len)), back, back_len) == 0) {
740 s[len - back_len] = 0;
750 The *_wa() functions take a combination of 7 bit ascii
751 and wide characters They are used so that you can use string
752 functions combining C string constants with ucs2 strings
754 The char* arguments must NOT be multibyte - to be completely sure
755 of this only pass string constants */
757 int strcmp_wa(const smb_ucs2_t *a, const char *b)
761 while (*b && *(COPY_UCS2_CHAR(&cp,a)) == UCS2_CHAR(*b)) {
765 return (*(COPY_UCS2_CHAR(&cp,a)) - UCS2_CHAR(*b));
768 int strncmp_wa(const smb_ucs2_t *a, const char *b, size_t len)
773 while ((n < len) && *b && *(COPY_UCS2_CHAR(&cp,a)) == UCS2_CHAR(*b)) {
778 return (len - n)?(*(COPY_UCS2_CHAR(&cp,a)) - UCS2_CHAR(*b)):0;
781 smb_ucs2_t *strpbrk_wa(const smb_ucs2_t *s, const char *p)
785 while (*(COPY_UCS2_CHAR(&cp,s))) {
787 for (i=0; p[i] && cp != UCS2_CHAR(p[i]); i++)
790 return (smb_ucs2_t *)s;
797 smb_ucs2_t *strstr_wa(const smb_ucs2_t *s, const char *ins)
806 inslen = strlen(ins);
809 while ((r = strchr_w(r, UCS2_CHAR(*ins)))) {
810 if (strncmp_wa(r, ins, inslen) == 0)
818 /*************************************************************
819 ascii only toupper - saves the need for smbd to be in C locale.
820 *************************************************************/
822 int toupper_ascii(int c)
824 smb_ucs2_t uc = toupper_w(UCS2_CHAR(c));
825 return UCS2_TO_CHAR(uc);
828 /*************************************************************
829 ascii only tolower - saves the need for smbd to be in C locale.
830 *************************************************************/
832 int tolower_ascii(int c)
834 smb_ucs2_t uc = tolower_w(UCS2_CHAR(c));
835 return UCS2_TO_CHAR(uc);
838 /*************************************************************
839 ascii only isupper - saves the need for smbd to be in C locale.
840 *************************************************************/
842 int isupper_ascii(int c)
844 return isupper_w(UCS2_CHAR(c));
847 /*************************************************************
848 ascii only islower - saves the need for smbd to be in C locale.
849 *************************************************************/
851 int islower_ascii(int c)
853 return islower_w(UCS2_CHAR(c));