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 /* Copy a string from little-endian or big-endian unicode source (depending
260 * on flags) to internal samba format destination
263 int rpcstr_pull(char* dest, void *src, int dest_len, int src_len, int flags)
272 return pull_ucs2(NULL, dest, src, dest_len, src_len, flags|STR_UNICODE|STR_NOALIGN);
275 /* Copy a string from little-endian or big-endian unicode source (depending
276 * on flags) to internal samba format destination. Allocates on talloc ctx.
279 int rpcstr_pull_talloc(TALLOC_CTX *ctx,
285 return pull_ucs2_base_talloc(ctx,
290 flags|STR_UNICODE|STR_NOALIGN);
294 /* Converts a string from internal samba format to unicode
297 int rpcstr_push(void *dest, const char *src, size_t dest_len, int flags)
299 return push_ucs2(NULL, dest, src, dest_len, flags|STR_UNICODE|STR_NOALIGN);
302 /* Converts a string from internal samba format to unicode. Always terminates.
303 * Actually just a wrapper round push_ucs2_talloc().
306 int rpcstr_push_talloc(TALLOC_CTX *ctx, smb_ucs2_t **dest, const char *src)
309 if (push_ucs2_talloc(ctx, dest, src, &size))
315 /*******************************************************************
316 Convert a wchar to upper case.
317 ********************************************************************/
319 smb_ucs2_t toupper_w(smb_ucs2_t val)
321 return upcase_table[SVAL(&val,0)];
324 /*******************************************************************
325 Convert a wchar to lower case.
326 ********************************************************************/
328 smb_ucs2_t tolower_w( smb_ucs2_t val )
330 return lowcase_table[SVAL(&val,0)];
333 /*******************************************************************
334 Determine if a character is lowercase.
335 ********************************************************************/
337 bool islower_w(smb_ucs2_t c)
339 return upcase_table[SVAL(&c,0)] != c;
342 /*******************************************************************
343 Determine if a character is uppercase.
344 ********************************************************************/
346 bool isupper_w(smb_ucs2_t c)
348 return lowcase_table[SVAL(&c,0)] != c;
351 /*******************************************************************
352 Determine if a character is valid in a 8.3 name.
353 ********************************************************************/
355 bool isvalid83_w(smb_ucs2_t c)
357 return valid_table[SVAL(&c,0)] != 0;
360 /*******************************************************************
361 Count the number of characters in a smb_ucs2_t string.
362 ********************************************************************/
364 size_t strlen_w(const smb_ucs2_t *src)
369 for(len = 0; *(COPY_UCS2_CHAR(&c,src)); src++, len++) {
376 /*******************************************************************
377 Count up to max number of characters in a smb_ucs2_t string.
378 ********************************************************************/
380 size_t strnlen_w(const smb_ucs2_t *src, size_t max)
385 for(len = 0; (len < max) && *(COPY_UCS2_CHAR(&c,src)); src++, len++) {
392 /*******************************************************************
394 ********************************************************************/
396 smb_ucs2_t *strchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
399 while (*(COPY_UCS2_CHAR(&cp,s))) {
401 return (smb_ucs2_t *)s;
406 return (smb_ucs2_t *)s;
412 smb_ucs2_t *strchr_wa(const smb_ucs2_t *s, char c)
414 return strchr_w(s, UCS2_CHAR(c));
417 /*******************************************************************
419 ********************************************************************/
421 smb_ucs2_t *strrchr_w(const smb_ucs2_t *s, smb_ucs2_t c)
424 const smb_ucs2_t *p = s;
425 int len = strlen_w(s);
432 if (c == *(COPY_UCS2_CHAR(&cp,p))) {
433 return (smb_ucs2_t *)p;
439 /*******************************************************************
440 Wide version of strrchr that returns after doing strrchr 'n' times.
441 ********************************************************************/
443 smb_ucs2_t *strnrchr_w(const smb_ucs2_t *s, smb_ucs2_t c, unsigned int n)
446 const smb_ucs2_t *p = s;
447 int len = strlen_w(s);
449 if (len == 0 || !n) {
454 if (c == *(COPY_UCS2_CHAR(&cp,p))) {
459 return (smb_ucs2_t *)p;
465 /*******************************************************************
467 ********************************************************************/
469 smb_ucs2_t *strstr_w(const smb_ucs2_t *s, const smb_ucs2_t *ins)
474 if (!s || !*s || !ins || !*ins) {
478 inslen = strlen_w(ins);
481 while ((r = strchr_w(r, *ins))) {
482 if (strncmp_w(r, ins, inslen) == 0) {
491 /*******************************************************************
492 Convert a string to lower case.
493 return True if any char is converted
494 ********************************************************************/
496 bool strlower_w(smb_ucs2_t *s)
501 while (*(COPY_UCS2_CHAR(&cp,s))) {
502 smb_ucs2_t v = tolower_w(cp);
504 COPY_UCS2_CHAR(s,&v);
512 /*******************************************************************
513 Convert a string to upper case.
514 return True if any char is converted
515 ********************************************************************/
517 bool strupper_w(smb_ucs2_t *s)
521 while (*(COPY_UCS2_CHAR(&cp,s))) {
522 smb_ucs2_t v = toupper_w(cp);
524 COPY_UCS2_CHAR(s,&v);
532 /*******************************************************************
533 Convert a string to "normal" form.
534 ********************************************************************/
536 void strnorm_w(smb_ucs2_t *s, int case_default)
538 if (case_default == CASE_UPPER) {
545 int strcmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
549 while ((*(COPY_UCS2_CHAR(&cpb,b))) && (*(COPY_UCS2_CHAR(&cpa,a)) == cpb)) {
553 return (*(COPY_UCS2_CHAR(&cpa,a)) - *(COPY_UCS2_CHAR(&cpb,b)));
554 /* warning: if *a != *b and both are not 0 we return a random
555 greater or lesser than 0 number not realted to which
559 int strncmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
564 while ((n < len) && (*(COPY_UCS2_CHAR(&cpb,b))) && (*(COPY_UCS2_CHAR(&cpa,a)) == cpb)) {
569 return (len - n)?(*(COPY_UCS2_CHAR(&cpa,a)) - *(COPY_UCS2_CHAR(&cpb,b))):0;
572 /*******************************************************************
573 Case insensitive string comparison.
574 ********************************************************************/
576 int strcasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b)
580 while ((*COPY_UCS2_CHAR(&cpb,b)) && toupper_w(*(COPY_UCS2_CHAR(&cpa,a))) == toupper_w(cpb)) {
584 return (tolower_w(*(COPY_UCS2_CHAR(&cpa,a))) - tolower_w(*(COPY_UCS2_CHAR(&cpb,b))));
587 /*******************************************************************
588 Case insensitive string comparison, length limited.
589 ********************************************************************/
591 int strncasecmp_w(const smb_ucs2_t *a, const smb_ucs2_t *b, size_t len)
596 while ((n < len) && *COPY_UCS2_CHAR(&cpb,b) && (toupper_w(*(COPY_UCS2_CHAR(&cpa,a))) == toupper_w(cpb))) {
601 return (len - n)?(tolower_w(*(COPY_UCS2_CHAR(&cpa,a))) - tolower_w(*(COPY_UCS2_CHAR(&cpb,b)))):0;
604 /*******************************************************************
606 ********************************************************************/
608 bool strequal_w(const smb_ucs2_t *s1, const smb_ucs2_t *s2)
617 return(strcasecmp_w(s1,s2)==0);
620 /*******************************************************************
621 Compare 2 strings up to and including the nth char.
622 ******************************************************************/
624 bool strnequal_w(const smb_ucs2_t *s1,const smb_ucs2_t *s2,size_t n)
629 if (!s1 || !s2 || !n) {
633 return(strncasecmp_w(s1,s2,n)==0);
636 /*******************************************************************
638 ********************************************************************/
640 smb_ucs2_t *strdup_w(const smb_ucs2_t *src)
642 return strndup_w(src, 0);
645 /* if len == 0 then duplicate the whole string */
647 smb_ucs2_t *strndup_w(const smb_ucs2_t *src, size_t len)
654 dest = SMB_MALLOC_ARRAY(smb_ucs2_t, len + 1);
656 DEBUG(0,("strdup_w: out of memory!\n"));
660 memcpy(dest, src, len * sizeof(smb_ucs2_t));
665 /*******************************************************************
666 Copy a string with max len.
667 ********************************************************************/
669 smb_ucs2_t *strncpy_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
678 for (len = 0; (*COPY_UCS2_CHAR(&cp,(src+len))) && (len < max); len++) {
679 cp = *COPY_UCS2_CHAR(dest+len,src+len);
682 for ( /*nothing*/ ; len < max; len++ ) {
683 cp = *COPY_UCS2_CHAR(dest+len,&cp);
689 /*******************************************************************
690 Append a string of len bytes and add a terminator.
691 ********************************************************************/
693 smb_ucs2_t *strncat_w(smb_ucs2_t *dest, const smb_ucs2_t *src, const size_t max)
703 start = strlen_w(dest);
704 len = strnlen_w(src, max);
706 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
707 z = *COPY_UCS2_CHAR(dest+start+len,&z);
712 smb_ucs2_t *strcat_w(smb_ucs2_t *dest, const smb_ucs2_t *src)
722 start = strlen_w(dest);
725 memcpy(&dest[start], src, len*sizeof(smb_ucs2_t));
726 z = *COPY_UCS2_CHAR(dest+start+len,&z);
732 /*******************************************************************
733 Replace any occurence of oldc with newc in unicode string.
734 ********************************************************************/
736 void string_replace_w(smb_ucs2_t *s, smb_ucs2_t oldc, smb_ucs2_t newc)
740 for(;*(COPY_UCS2_CHAR(&cp,s));s++) {
742 COPY_UCS2_CHAR(s,&newc);
747 /*******************************************************************
749 ********************************************************************/
751 bool trim_string_w(smb_ucs2_t *s, const smb_ucs2_t *front,
752 const smb_ucs2_t *back)
755 size_t len, front_len, back_len;
763 if (front && *front) {
764 front_len = strlen_w(front);
765 while (len && strncmp_w(s, front, front_len) == 0) {
766 memmove(s, (s + front_len), (len - front_len + 1) * sizeof(smb_ucs2_t));
773 back_len = strlen_w(back);
774 while (len && strncmp_w((s + (len - back_len)), back, back_len) == 0) {
775 s[len - back_len] = 0;
785 The *_wa() functions take a combination of 7 bit ascii
786 and wide characters They are used so that you can use string
787 functions combining C string constants with ucs2 strings
789 The char* arguments must NOT be multibyte - to be completely sure
790 of this only pass string constants */
792 int strcmp_wa(const smb_ucs2_t *a, const char *b)
796 while (*b && *(COPY_UCS2_CHAR(&cp,a)) == UCS2_CHAR(*b)) {
800 return (*(COPY_UCS2_CHAR(&cp,a)) - UCS2_CHAR(*b));
803 int strncmp_wa(const smb_ucs2_t *a, const char *b, size_t len)
808 while ((n < len) && *b && *(COPY_UCS2_CHAR(&cp,a)) == UCS2_CHAR(*b)) {
813 return (len - n)?(*(COPY_UCS2_CHAR(&cp,a)) - UCS2_CHAR(*b)):0;
816 smb_ucs2_t *strpbrk_wa(const smb_ucs2_t *s, const char *p)
820 while (*(COPY_UCS2_CHAR(&cp,s))) {
822 for (i=0; p[i] && cp != UCS2_CHAR(p[i]); i++)
825 return (smb_ucs2_t *)s;
832 smb_ucs2_t *strstr_wa(const smb_ucs2_t *s, const char *ins)
841 inslen = strlen(ins);
844 while ((r = strchr_w(r, UCS2_CHAR(*ins)))) {
845 if (strncmp_wa(r, ins, inslen) == 0)
853 /*************************************************************
854 ascii only toupper - saves the need for smbd to be in C locale.
855 *************************************************************/
857 int toupper_ascii(int c)
859 smb_ucs2_t uc = toupper_w(UCS2_CHAR(c));
860 return UCS2_TO_CHAR(uc);
863 /*************************************************************
864 ascii only tolower - saves the need for smbd to be in C locale.
865 *************************************************************/
867 int tolower_ascii(int c)
869 smb_ucs2_t uc = tolower_w(UCS2_CHAR(c));
870 return UCS2_TO_CHAR(uc);
873 /*************************************************************
874 ascii only isupper - saves the need for smbd to be in C locale.
875 *************************************************************/
877 int isupper_ascii(int c)
879 return isupper_w(UCS2_CHAR(c));
882 /*************************************************************
883 ascii only islower - saves the need for smbd to be in C locale.
884 *************************************************************/
886 int islower_ascii(int c)
888 return islower_w(UCS2_CHAR(c));