2 Unix SMB/Netbios implementation.
5 Copyright (C) Andrew Tridgell 1992-1998
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.
22 /* -------------------------------------------------------------------------- **
25 * March/April 1998 CRH
26 * - Many of the functions in this module overwrite string buffers passed to
27 * them. This causes a variety of problems and is, generally speaking,
28 * dangerous and scarry. See the kludge notes in name_map_mangle()
30 * - It seems that something is calling name_map_mangle() twice. The
31 * first call is probably some sort of test. Names which contain
32 * illegal characters are being doubly mangled. I'm not sure, but
33 * I'm guessing the problem is in server.c.
35 * -------------------------------------------------------------------------- **
38 /* -------------------------------------------------------------------------- **
41 * March/April 1998 CRH
42 * Updated a bit. Rewrote is_mangled() to be a bit more selective.
43 * Rewrote the mangled name cache. Added comments here and there.
45 * -------------------------------------------------------------------------- **
51 /* -------------------------------------------------------------------------- **
52 * External Variables...
55 extern int DEBUGLEVEL; /* Global debug level. */
56 extern int case_default; /* Are conforming 8.3 names all upper or lower? */
57 extern BOOL case_mangle; /* If true, all chars in 8.3 should be same case. */
59 /* -------------------------------------------------------------------------- **
62 * magic_char - This is the magic char used for mangling. It's
63 * global. There is a call to lp_magicchar() in server.c
64 * that is used to override the initial value.
66 * MANGLE_BASE - This is the number of characters we use for name mangling.
68 * basechars - The set characters used for name mangling. This
69 * is static (scope is this file only).
71 * mangle() - Macro used to select a character from basechars (i.e.,
72 * mangle(n) will return the nth digit, modulo MANGLE_BASE).
74 * chartest - array 0..255. The index range is the set of all possible
75 * values of a byte. For each byte value, the content is a
76 * two nibble pair. See BASECHAR_MASK and ILLEGAL_MASK,
79 * ct_initialized - False until the chartest array has been initialized via
80 * a call to init_chartest().
82 * BASECHAR_MASK - Masks the upper nibble of a one-byte value.
84 * ILLEGAL_MASK - Masks the lower nibble of a one-byte value.
86 * isbasecahr() - Given a character, check the chartest array to see
87 * if that character is in the basechars set. This is
88 * faster than using strchr_m().
90 * isillegal() - Given a character, check the chartest array to see
91 * if that character is in the illegal characters set.
92 * This is faster than using strchr_m().
94 * mangled_cache - Cache header used for storing mangled -> original
97 * mc_initialized - False until the mangled_cache structure has been
98 * initialized via a call to reset_mangled_cache().
100 * MANGLED_CACHE_MAX_ENTRIES - Default maximum number of entries for the
101 * cache. A value of 0 indicates "infinite".
103 * MANGLED_CACHE_MAX_MEMORY - Default maximum amount of memory for the
104 * cache. When the cache was kept as an array of 256
105 * byte strings, the default cache size was 50 entries.
106 * This required a fixed 12.5Kbytes of memory. The
107 * mangled stack parameter is no longer used (though
108 * this might change). We're now using a fixed 16Kbyte
109 * maximum cache size. This will probably be much more
113 char magic_char = '~';
115 static char basechars[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_-!@#$%";
116 #define MANGLE_BASE ( (sizeof(basechars)/sizeof(char)) - 1 )
118 static unsigned char chartest[256] = { 0 };
119 static BOOL ct_initialized = False;
121 #define mangle(V) ((char)(basechars[(V) % MANGLE_BASE]))
122 #define BASECHAR_MASK 0xf0
123 #define ILLEGAL_MASK 0x0f
124 #define isbasechar(C) ( (chartest[ ((C) & 0xff) ]) & BASECHAR_MASK )
125 #define isillegal(C) ( (chartest[ ((C) & 0xff) ]) & ILLEGAL_MASK )
127 static ubi_cacheRoot mangled_cache[1] = {{ { 0, 0, 0, 0 }, 0, 0, 0, 0, 0, 0 }};
128 static BOOL mc_initialized = False;
129 #define MANGLED_CACHE_MAX_ENTRIES 0
130 #define MANGLED_CACHE_MAX_MEMORY 16384
133 /* -------------------------------------------------------------------------- **
137 /* ************************************************************************** **
138 * Initialize the static character test array.
144 * Notes: This function changes (loads) the contents of the <chartest>
145 * array. The scope of <chartest> is this file.
147 * ************************************************************************** **
149 static void init_chartest( void )
151 char *illegalchars = "*\\/?<>|\":";
154 memset( (char *)chartest, '\0', 256 );
156 for( s = (unsigned char *)illegalchars; *s; s++ )
157 chartest[*s] = ILLEGAL_MASK;
159 for( s = (unsigned char *)basechars; *s; s++ )
160 chartest[*s] |= BASECHAR_MASK;
162 ct_initialized = True;
163 } /* init_chartest */
165 /* ************************************************************************** **
166 * Return True if a name is a special msdos reserved name.
168 * Input: fname - String containing the name to be tested.
170 * Output: True, if the name matches one of the list of reserved names.
172 * Notes: This is a static function called by is_8_3(), below.
174 * ************************************************************************** **
176 static BOOL is_reserved_msdos( char *fname )
181 StrnCpy (upperFname, fname, 12);
183 /* lpt1.txt and con.txt etc are also illegal */
184 p = strchr_m(upperFname,'.');
188 strupper( upperFname );
190 switch( upperFname[0] )
193 if( 0 == strcmp( p, "UX" ) )
197 if( (0 == strcmp( p, "LOCK$" ))
198 || (0 == strcmp( p, "ON" ))
199 || (0 == strcmp( p, "OM1" ))
200 || (0 == strcmp( p, "OM2" ))
201 || (0 == strcmp( p, "OM3" ))
202 || (0 == strcmp( p, "OM4" ))
207 if( (0 == strcmp( p, "PT1" ))
208 || (0 == strcmp( p, "PT2" ))
209 || (0 == strcmp( p, "PT3" ))
214 if( 0 == strcmp( p, "UL" ) )
218 if( 0 == strcmp( p, "RN" ) )
224 } /* is_reserved_msdos */
226 /* ************************************************************************** **
227 * Determine whether or not a given name contains illegal characters, even
230 * Input: name - The name to be tested.
232 * Output: True if an illegal character was found in <name>, else False.
234 * Notes: This is used to test a name on the host system, long or short,
235 * for characters that would be illegal on most client systems,
236 * particularly DOS and Windows systems. Unix and AmigaOS, for
237 * example, allow a filenames which contain such oddities as
238 * quotes ("). If a name is found which does contain an illegal
239 * character, it is mangled even if it conforms to the 8.3
242 * ************************************************************************** **
244 static BOOL is_illegal_name( char *name )
251 if( !ct_initialized )
254 s = (unsigned char *)name;
257 if( *s>0x7F && isillegal( *s ) )
264 } /* is_illegal_name */
266 /* ************************************************************************** **
267 * Return True if the name *could be* a mangled name.
269 * Input: s - A path name - in UNIX pathname format.
271 * Output: True if the name matches the pattern described below in the
274 * Notes: The input name is *not* tested for 8.3 compliance. This must be
275 * done separately. This function returns true if the name contains
276 * a magic character followed by excactly two characters from the
277 * basechars list (above), which in turn are followed either by the
278 * nul (end of string) byte or a dot (extension) or by a '/' (end of
281 * ************************************************************************** **
283 BOOL is_mangled( char *s )
287 if( !ct_initialized )
290 magic = strchr_m( s, magic_char );
291 while( magic && magic[1] && magic[2] ) /* 3 chars, 1st is magic. */
293 if( ('.' == magic[3] || '/' == magic[3] || !(magic[3])) /* Ends with '.' or nul or '/' ? */
294 && isbasechar( toupper(magic[1]) ) /* is 2nd char basechar? */
295 && isbasechar( toupper(magic[2]) ) ) /* is 3rd char basechar? */
296 return( True ); /* If all above, then true, */
297 magic = strchr_m( magic+1, magic_char ); /* else seek next magic. */
302 /* ************************************************************************** **
303 * Return True if the name is a valid DOS name in 8.3 DOS format.
305 * Input: fname - File name to be checked.
306 * check_case - If True, and if case_mangle is True, then the
307 * name will be checked to see if all characters
308 * are the correct case. See case_mangle and
309 * case_default above.
311 * Output: True if the name is a valid DOS name, else FALSE.
313 * ************************************************************************** **
315 BOOL is_8_3( char *fname, BOOL check_case )
321 char *slash_pos = strrchr_m( fname, '/' );
323 /* If there is a directory path, skip it. */
325 fname = slash_pos + 1;
326 len = strlen( fname );
328 DEBUG( 5, ( "Checking %s for 8.3\n", fname ) );
330 /* Can't be 0 chars or longer than 12 chars */
331 if( (len == 0) || (len > 12) )
334 /* Mustn't be an MS-DOS Special file such as lpt1 or even lpt1.txt */
335 if( is_reserved_msdos( fname ) )
338 /* Check that all characters are the correct case, if asked to do so. */
339 if( check_case && case_mangle )
341 switch( case_default )
344 if( strhasupper( fname ) )
348 if( strhaslower( fname ) )
354 /* Can't contain invalid dos chars */
355 /* Windows use the ANSI charset.
356 But filenames are translated in the PC charset.
357 This Translation may be more or less relaxed depending
358 the Windows application. */
360 /* %%% A nice improvment to name mangling would be to translate
361 filename to ANSI charset on the smb server host */
367 if( *p == '.' && !dot_pos )
370 if( !isdoschar( *p ) )
375 /* no dot and less than 9 means OK */
379 l = PTR_DIFF( dot_pos, fname );
381 /* base must be at least 1 char except special cases . and .. */
383 return( 0 == strcmp( fname, "." ) || 0 == strcmp( fname, ".." ) );
385 /* base can't be greater than 8 */
389 /* see smb.conf(5) for a description of the 'strip dot' parameter. */
392 && !strchr_m( dot_pos + 1, '.' ) )
398 /* extension must be between 1 and 3 */
399 if( (len - l < 2 ) || (len - l > 4) )
402 /* extensions may not have a dot */
403 if( strchr_m( dot_pos+1, '.' ) )
406 /* must be in 8.3 format */
411 /* ************************************************************************** **
412 * Compare two cache keys and return a value indicating their ordinal
415 * Input: ItemPtr - Pointer to a comparison key. In this case, this will
416 * be a mangled name string.
417 * NodePtr - Pointer to a node in the cache. The node structure
418 * will be followed in memory by a mangled name string.
420 * Output: A signed integer, as follows:
421 * (x < 0) <==> Key1 less than Key2
422 * (x == 0) <==> Key1 equals Key2
423 * (x > 0) <==> Key1 greater than Key2
425 * Notes: This is a ubiqx-style comparison routine. See ubi_BinTree for
428 * ************************************************************************** **
430 static signed int cache_compare( ubi_btItemPtr ItemPtr, ubi_btNodePtr NodePtr )
432 char *Key1 = (char *)ItemPtr;
433 char *Key2 = (char *)(((ubi_cacheEntryPtr)NodePtr) + 1);
435 return( StrCaseCmp( Key1, Key2 ) );
436 } /* cache_compare */
438 /* ************************************************************************** **
439 * Free a cache entry.
441 * Input: WarrenZevon - Pointer to the entry that is to be returned to
445 * Notes: This function gets around the possibility that the standard
446 * free() function may be implemented as a macro, or other evil
447 * subversions (oh, so much fun).
449 * ************************************************************************** **
451 static void cache_free_entry( ubi_trNodePtr WarrenZevon )
453 ZERO_STRUCTP(WarrenZevon);
454 SAFE_FREE( WarrenZevon );
455 } /* cache_free_entry */
457 /* ************************************************************************** **
458 * Initializes or clears the mangled cache.
463 * Notes: There is a section below that is commented out. It shows how
464 * one might use lp_ calls to set the maximum memory and entry size
465 * of the cache. You might also want to remove the constants used
466 * in ubi_cacheInit() and replace them with lp_ calls. If so, then
467 * the calls to ubi_cacheSetMax*() would be moved into the else
468 * clause. Another option would be to pass in the max_entries and
469 * max_memory values as parameters. crh 09-Apr-1998.
471 * ************************************************************************** **
473 void reset_mangled_cache( void )
475 if( !mc_initialized )
477 (void)ubi_cacheInit( mangled_cache,
480 MANGLED_CACHE_MAX_ENTRIES,
481 MANGLED_CACHE_MAX_MEMORY );
482 mc_initialized = True;
486 (void)ubi_cacheClear( mangled_cache );
490 (void)ubi_cacheSetMaxEntries( mangled_cache, lp_mangled_cache_entries() );
491 (void)ubi_cacheSetMaxMemory( mangled_cache, lp_mangled_cache_memory() );
493 } /* reset_mangled_cache */
496 /* ************************************************************************** **
497 * Add a mangled name into the cache.
499 * Notes: If the mangled cache has not been initialized, then the
500 * function will simply fail. It could initialize the cache,
501 * but that's not the way it was done before I changed the
502 * cache mechanism, so I'm sticking with the old method.
504 * If the extension of the raw name maps directly to the
505 * extension of the mangled name, then we'll store both names
506 * *without* extensions. That way, we can provide consistent
507 * reverse mangling for all names that match. The test here is
508 * a bit more careful than the one done in earlier versions of
511 * - the extension must exist on the raw name,
512 * - it must be all lower case
513 * - it must match the mangled extension (to prove that no
514 * mangling occurred).
518 * ************************************************************************** **
520 static void cache_mangled_name( char *mangled_name, char *raw_name )
522 ubi_cacheEntryPtr new_entry;
529 /* If the cache isn't initialized, give up. */
530 if( !mc_initialized )
533 /* Init the string lengths. */
534 mangled_len = strlen( mangled_name );
535 raw_len = strlen( raw_name );
537 /* See if the extensions are unmangled. If so, store the entry
538 * without the extension, thus creating a "group" reverse map.
540 s1 = strrchr_m( mangled_name, '.' );
541 if( s1 && (s2 = strrchr_m( raw_name, '.' )) )
544 while( s1[i] && (tolower( s1[1] ) == s2[i]) )
546 if( !s1[i] && !s2[i] )
553 /* Allocate a new cache entry. If the allocation fails, just return. */
554 i = sizeof( ubi_cacheEntry ) + mangled_len + raw_len + 2;
555 new_entry = malloc( i );
559 /* Fill the new cache entry, and add it to the cache. */
560 s1 = (char *)(new_entry + 1);
561 s2 = (char *)&(s1[mangled_len + 1]);
562 (void)StrnCpy( s1, mangled_name, mangled_len );
563 (void)StrnCpy( s2, raw_name, raw_len );
564 ubi_cachePut( mangled_cache, i, new_entry, s1 );
565 } /* cache_mangled_name */
567 /* ************************************************************************** **
568 * Check for a name on the mangled name stack
570 * Input: s - Input *and* output string buffer.
572 * Output: True if the name was found in the cache, else False.
574 * Notes: If a reverse map is found, the function will overwrite the string
575 * space indicated by the input pointer <s>. This is frightening.
576 * It should be rewritten to return NULL if the long name was not
577 * found, and a pointer to the long name if it was found.
579 * ************************************************************************** **
582 BOOL check_mangled_cache( char *s )
584 ubi_cacheEntryPtr FoundPtr;
585 char *ext_start = NULL;
587 char *saved_ext = NULL;
589 /* If the cache isn't initialized, give up. */
590 if( !mc_initialized )
593 FoundPtr = ubi_cacheGet( mangled_cache, (ubi_trItemPtr)s );
595 /* If we didn't find the name *with* the extension, try without. */
598 ext_start = strrchr_m( s, '.' );
601 if((saved_ext = strdup(ext_start)) == NULL)
605 FoundPtr = ubi_cacheGet( mangled_cache, (ubi_trItemPtr)s );
607 * At this point s is the name without the
608 * extension. We re-add the extension if saved_ext
609 * is not null, before freeing saved_ext.
614 /* Okay, if we haven't found it we're done. */
619 /* Replace the saved_ext as it was truncated. */
620 (void)pstrcat( s, saved_ext );
621 SAFE_FREE(saved_ext);
626 /* If we *did* find it, we need to copy it into the string buffer. */
627 found_name = (char *)(FoundPtr + 1);
628 found_name += (strlen( found_name ) + 1);
630 DEBUG( 3, ("Found %s on mangled stack ", s) );
632 (void)pstrcpy( s, found_name );
635 /* Replace the saved_ext as it was truncated. */
636 (void)pstrcat( s, saved_ext );
637 SAFE_FREE(saved_ext);
640 DEBUG( 3, ("as %s\n", s) );
643 } /* check_mangled_cache */
646 /* ************************************************************************** **
647 * Used only in do_fwd_mangled_map(), below.
648 * ************************************************************************** **
650 static char *map_filename( char *s, /* This is null terminated */
651 char *pattern, /* This isn't. */
652 int len ) /* This is the length of pattern. */
654 static pstring matching_bit; /* The bit of the string which matches */
655 /* a * in pattern if indeed there is a * */
656 char *sp; /* Pointer into s. */
657 char *pp; /* Pointer into p. */
658 char *match_start; /* Where the matching bit starts. */
661 StrnCpy( pat, pattern, len ); /* Get pattern into a proper string! */
662 pstrcpy( matching_bit, "" ); /* Match but no star gets this. */
663 pp = pat; /* Initialize the pointers. */
666 if( strequal(s, ".") || strequal(s, ".."))
668 return NULL; /* Do not map '.' and '..' */
671 if( (len == 1) && (*pattern == '*') )
673 return NULL; /* Impossible, too ambiguous for */
676 while( (*sp) /* Not the end of the string. */
677 && (*pp) /* Not the end of the pattern. */
678 && (*sp == *pp) /* The two match. */
679 && (*pp != '*') ) /* No wildcard. */
681 sp++; /* Keep looking. */
685 if( !*sp && !*pp ) /* End of pattern. */
686 return( matching_bit ); /* Simple match. Return empty string. */
690 pp++; /* Always interrested in the chacter */
692 if( !*pp ) /* It is at the end of the pattern. */
694 StrnCpy( matching_bit, s, sp-s );
695 return( matching_bit );
699 /* The next character in pattern must match a character further */
700 /* along s than sp so look for that character. */
702 while( (*sp) /* Not the end of s. */
703 && (*sp != *pp) ) /* Not the same */
704 sp++; /* Keep looking. */
705 if( !*sp ) /* Got to the end without a match. */
708 } /* Still hope for a match. */
711 /* Now sp should point to a matching character. */
712 StrnCpy(matching_bit, match_start, sp-match_start);
713 /* Back to needing a stright match again. */
714 while( (*sp) /* Not the end of the string. */
715 && (*pp) /* Not the end of the pattern. */
716 && (*sp == *pp) ) /* The two match. */
718 sp++; /* Keep looking. */
721 if( !*sp && !*pp ) /* Both at end so it matched */
722 return( matching_bit );
728 return( NULL ); /* No match. */
732 /* ************************************************************************** **
733 * MangledMap is a series of name pairs in () separated by spaces.
734 * If s matches the first of the pair then the name given is the
735 * second of the pair. A * means any number of any character and if
736 * present in the second of the pair as well as the first the
737 * matching part of the first string takes the place of the * in the
740 * I wanted this so that we could have RCS files which can be used
741 * by UNIX and DOS programs. My mapping string is (RCS rcs) which
742 * converts the UNIX RCS file subdirectory to lowercase thus
743 * preventing mangling.
745 * (I think Andrew wrote the above, but I'm not sure. -- CRH)
747 * See 'mangled map' in smb.conf(5).
749 * ************************************************************************** **
751 static void do_fwd_mangled_map(char *s, char *MangledMap)
753 char *start=MangledMap; /* Use this to search for mappings. */
754 char *end; /* Used to find the end of strings. */
756 pstring new_string; /* Make up the result here. */
757 char *np; /* Points into new_string. */
759 DEBUG( 5, ("Mangled Mapping '%s' map '%s'\n", s, MangledMap) );
762 while( (*start) && (*start != '(') )
765 continue; /* Always check for the end. */
766 start++; /* Skip the ( */
767 end = start; /* Search for the ' ' or a ')' */
768 DEBUG( 5, ("Start of first in pair '%s'\n", start) );
769 while( (*end) && !((*end == ' ') || (*end == ')')) )
774 continue; /* Always check for the end. */
776 DEBUG( 5, ("End of first in pair '%s'\n", end) );
777 if( (match_string = map_filename( s, start, end-start )) )
779 DEBUG( 5, ("Found a match\n") );
781 start = end + 1; /* Point to start of what it is to become. */
782 DEBUG( 5, ("Start of second in pair '%s'\n", start) );
785 while( (*end) /* Not the end of string. */
786 && (*end != ')') /* Not the end of the pattern. */
787 && (*end != '*') ) /* Not a wildcard. */
792 continue; /* Always check for the end. */
796 pstrcpy( np, match_string );
797 np += strlen( match_string );
798 end++; /* Skip the '*' */
799 while( (*end) /* Not the end of string. */
800 && (*end != ')') /* Not the end of the pattern. */
801 && (*end != '*') ) /* Not a wildcard. */
807 continue; /* Always check for the end. */
809 *np++ = '\0'; /* NULL terminate it. */
810 DEBUG(5,("End of second in pair '%s'\n", end));
811 pstrcpy( s, new_string ); /* Substitute with the new name. */
812 DEBUG( 5, ("s is now '%s'\n", s) );
814 start = end; /* Skip a bit which cannot be wanted anymore. */
817 } /* do_fwd_mangled_map */
819 /*****************************************************************************
820 * do the actual mangling to 8.3 format
821 * the buffer must be able to hold 13 characters (including the null)
822 *****************************************************************************
824 void mangle_name_83( char *s)
836 p = strrchr_m(s,'.');
837 if( p && (strlen(p+1) < (size_t)4) )
839 BOOL all_normal = ( strisnormal(p+1) ); /* XXXXXXXXX */
841 if( all_normal && p[1] != 0 )
844 csum = str_checksum( s );
848 csum = str_checksum(s);
851 csum = str_checksum(s);
855 DEBUG( 5, ("Mangling name %s to ",s) );
860 safe_strcpy( extension, "___", 3 );
864 while( *p && extlen < 3 )
866 if( /*isdoschar (*p) &&*/ *p != '.' )
867 extension[extlen++] = p[0];
870 extension[extlen] = 0;
876 while( *p && baselen < 5 )
878 if( /*isdoschar( *p ) &&*/ *p != '.' )
879 base[baselen++] = p[0];
884 csum = csum % (MANGLE_BASE*MANGLE_BASE);
886 (void)slprintf(s, 12, "%s%c%c%c",
887 base, magic_char, mangle( csum/MANGLE_BASE ), mangle( csum ) );
891 (void)pstrcat( s, "." );
892 (void)pstrcat( s, extension );
895 DEBUG( 5, ( "%s\n", s ) );
897 } /* mangle_name_83 */
899 /*****************************************************************************
900 * Convert a filename to DOS format. Return True if successful.
902 * Input: OutName - Source *and* destination buffer.
904 * NOTE that OutName must point to a memory space that
905 * is at least 13 bytes in size!
907 * need83 - If False, name mangling will be skipped unless the
908 * name contains illegal characters. Mapping will still
909 * be done, if appropriate. This is probably used to
910 * signal that a client does not require name mangling,
911 * thus skipping the name mangling even on shares which
912 * have name-mangling turned on.
913 * cache83 - If False, the mangled name cache will not be updated.
914 * This is usually used to prevent that we overwrite
915 * a conflicting cache entry prematurely, i.e. before
916 * we know whether the client is really interested in the
917 * current name. (See PR#13758). UKD.
918 * snum - Share number. This identifies the share in which the
921 * Output: Returns False only if the name wanted mangling but the share does
922 * not have name mangling turned on.
924 * ****************************************************************************
926 BOOL name_map_mangle(char *OutName, BOOL need83, BOOL cache83, int snum)
929 DEBUG(5,("name_map_mangle( %s, need83 = %s, cache83 = %s, %d )\n", OutName,
930 need83 ? "TRUE" : "FALSE", cache83 ? "TRUE" : "FALSE", snum));
932 #ifdef MANGLE_LONG_FILENAMES
933 if( !need83 && is_illegal_name(OutName) )
937 /* apply any name mappings */
938 map = lp_mangled_map(snum);
941 do_fwd_mangled_map( OutName, map );
944 /* check if it's already in 8.3 format */
945 if (need83 && !is_8_3(OutName, True)) {
948 if (!lp_manglednames(snum)) {
952 /* mangle it into 8.3 */
954 tmp = strdup(OutName);
956 mangle_name_83(OutName);
959 cache_mangled_name(OutName, tmp);
964 DEBUG(5,("name_map_mangle() ==> [%s]\n", OutName));
966 } /* name_map_mangle */
973 #define MANGLE_TDB_VERSION "20010927"
974 #define MANGLE_TDB_FILE_NAME "mangle.tdb"
975 #define MANGLED_PREFIX "MANGLED_"
976 #define LONG_PREFIX "LONG_"
977 #define COUNTER_PREFIX "COUNTER_"
978 #define MANGLE_COUNTER_MAX 99
979 #define MANGLE_SUFFIX_SIZE 2
982 struct mt_enum_info {
983 TDB_CONTEXT *mangle_tdb;
988 static struct mt_enum_info global_mt_ent = {0, 0};
990 static int POW10(unsigned int exp)
1002 static BOOL init_mangle_tdb(void)
1006 if (global_mt_ent.mangle_tdb == 0)
1008 tdbfile = lock_path(MANGLE_TDB_FILE_NAME); /* this return a static pstring do not try to free it */
1011 if (!(global_mt_ent.mangle_tdb = tdb_open_log(tdbfile, 0, TDB_DEFAULT, O_RDWR | O_CREAT, 0600)))
1013 DEBUG(0, ("Unable to open Mangle TDB\n"));
1022 int dos_to_ucs2(const void *base_ptr, void *dest, const char *src, int dest_len, int flags)
1025 int src_len = strlen(src);
1028 /* treat a pstring as "unlimited" length */
1029 if (dest_len == -1) {
1030 dest_len = sizeof(pstring);
1033 if (flags & STR_UPPER) {
1034 pstrcpy(tmpbuf, src);
1039 if (flags & STR_TERMINATE) {
1043 if (ucs2_align(base_ptr, dest, flags)) {
1045 dest = (void *)((char *)dest + 1);
1046 if (dest_len) dest_len--;
1050 /* ucs2 is always a multiple of 2 bytes */
1053 len += convert_string(CH_DOS, CH_UCS2, src, src_len, dest, dest_len);
1058 int ucs2_to_dos(const void *base_ptr, char *dest, const void *src, int dest_len, int src_len, int flags)
1062 if (dest_len == -1) {
1063 dest_len = sizeof(pstring);
1066 if (ucs2_align(base_ptr, src, flags)) {
1067 src = (const void *)((char *)src + 1);
1068 if (src_len > 0) src_len--;
1071 if (flags & STR_TERMINATE) src_len = strlen_w(src)*2+2;
1073 /* ucs2 is always a multiple of 2 bytes */
1076 ret = convert_string(CH_UCS2, CH_DOS, src, src_len, dest, dest_len);
1077 if (dest_len) dest[MIN(ret, dest_len-1)] = 0;
1082 /* return False if something fail and
1083 * return 2 alloced unicode strings that contain prefix and extension
1085 static BOOL mangle_get_prefix(const smb_ucs2_t *ucs2_string, smb_ucs2_t **prefix, smb_ucs2_t **extension)
1091 *prefix = strdup_w(ucs2_string);
1094 DEBUG(0,("mangle_get_prefix: out of memory!\n"));
1097 str_len = strlen_w(*prefix);
1098 if (p = strrchr_wa(*prefix, '.'))
1100 /* TODO: check it is <4 in dos charset */
1101 if ((str_len - ((p - *prefix) / sizeof(smb_ucs2_t))) < 4) /* check extension */
1105 *extension = strdup_w(p);
1108 DEBUG(0,("mangle_get_prefix: out of memory!\n"));
1119 /* mangled must contain only the file name, not a path.
1120 and MUST be ZERO terminated */
1121 smb_ucs2_t *unmangle(const smb_ucs2_t *mangled)
1126 smb_ucs2_t *pref, *ext, *retstr;
1127 size_t long_len, ext_len;
1130 if (strlen_w(mangled) > 12) return NULL;
1131 if (!strchr_wa(mangled, '~')) return NULL;
1132 if (!init_mangle_tdb()) return NULL;
1134 ret = mangle_get_prefix(mangled, &pref, &ext);
1135 if (!ret) return NULL;
1137 /* TODO: get out extension */
1139 /* set search key */
1140 ucs2_to_dos(NULL, mufname, pref, sizeof(mufname), 0, STR_TERMINATE);
1142 slprintf(keystr, sizeof(keystr) - 1, "%s%s", MANGLED_PREFIX, mufname);
1144 key.dsize = strlen (keystr) + 1;
1146 /* get the record */
1147 data = tdb_fetch(global_mt_ent.mangle_tdb, key);
1149 if (!data.dptr) /* not found */
1151 DEBUG(5,("unmangle: failed retrieve from db %s\n", tdb_errorstr(global_mt_ent.mangle_tdb)));
1158 long_len = data.dsize / 2; /* terminator counted on purpose, will contain '.' */
1159 ext_len = strlen_w(ext);
1160 retstr = (smb_ucs2_t *)malloc((long_len + ext_len + 1)*sizeof(smb_ucs2_t));
1163 DEBUG(0, ("unamngle: out of memory!\n"));
1166 strncpy_w(retstr, (smb_ucs2_t *)data.dptr, long_len);
1167 retstr[long_len] = UCS2_CHAR('.');
1168 retstr[long_len + 1] = 0;
1169 strncat_w(retstr, ext, ext_len);
1173 retstr = strdup_w((smb_ucs2_t *)data.dptr);
1176 DEBUG(0, ("unamngle: out of memory!\n"));
1183 SAFE_FREE(data.dptr);
1190 /* unmangled must contain only the file name, not a path.
1191 and MUST be ZERO terminated */
1192 smb_ucs2_t *_mangle(const smb_ucs2_t *unmangled)
1194 TDB_DATA data, key, klock;
1200 BOOL tclock = False;
1201 char suffix[MANGLE_SUFFIX_SIZE + 1];
1202 smb_ucs2_t *mangled = NULL;
1203 smb_ucs2_t *um, *ext, *p = NULL;
1205 size_t pref_len, ext_len;
1209 if (!init_mangle_tdb()) return NULL;
1211 /* TODO: if it is a path return a failure ?? */
1212 if (!mangle_get_prefix(unmangled, &um, &ext)) return NULL;
1214 /* test if the same is yet mangled */
1216 /* set search key */
1217 pull_ucs2(NULL, longname, um, sizeof(longname), 0, STR_TERMINATE);
1218 slprintf(keystr, sizeof(keystr)-1, "%s%s", LONG_PREFIX, longname);
1220 key.dsize = strlen(keystr) + 1;
1222 /* get the record */
1223 data = tdb_fetch (global_mt_ent.mangle_tdb, key);
1224 if (!data.dptr) /* not found */
1226 if (tdb_error(global_mt_ent.mangle_tdb) != TDB_ERR_NOEXIST)
1228 DEBUG(0, ("mangle: database retrieval error: %s\n",
1229 tdb_errorstr(global_mt_ent.mangle_tdb)));
1233 /* if not find the first free possibile mangled name */
1239 pos = 8 - n - MANGLE_SUFFIX_SIZE;
1242 DEBUG(0, ("mangle: unable to mangle file name!\n"));
1245 strncpy_w(temp, um, pos);
1248 ucs2_to_dos(NULL, prefix, temp, sizeof(prefix), 0, STR_TERMINATE);
1250 while (strlen(prefix) > 8 - (MANGLE_SUFFIX_SIZE + 1));
1252 slprintf(keylock, sizeof(keylock)-1, "%s%s", COUNTER_PREFIX, prefix);
1253 klock.dptr = keylock;
1254 klock.dsize = strlen(keylock) + 1;
1257 data.dptr = (char *)&c;
1258 data.dsize = sizeof(uint32);
1259 /* try to insert a new counter prefix, if it exist the call will
1260 fail (correct) otherwise it will create a new entry with counter set
1263 tdb_store(global_mt_ent.mangle_tdb, klock, data, TDB_INSERT);
1265 /* lock the mangle counter for this prefix */
1266 if (!tdb_chainlock(global_mt_ent.mangle_tdb, klock))
1268 DEBUG(0,("mangle: failed to lock database\n!"));
1273 data = tdb_fetch(global_mt_ent.mangle_tdb, klock);
1276 DEBUG(0, ("mangle: database retrieval error: %s\n",
1277 tdb_errorstr(global_mt_ent.mangle_tdb)));
1280 c = *((uint32 *)data.dptr);
1283 temp[pos] = UCS2_CHAR('~');
1285 snprintf(suffix, MANGLE_SUFFIX_SIZE + 1, "%.6d", c);
1286 strncat_wa(temp, &suffix[6 - MANGLE_SUFFIX_SIZE], MANGLE_SUFFIX_SIZE + 1);
1288 ucs2_to_dos(NULL, mufname, temp, sizeof(mufname), 0, STR_TERMINATE);
1289 if (strlen(mufname) > 8)
1291 DEBUG(0, ("mangle: darn, logic error aborting!\n"));
1295 /* store the long entry with mangled key */
1296 slprintf(keystr, sizeof(keystr)-1, "%s%s", MANGLED_PREFIX, mufname);
1298 key.dsize = strlen (keystr) + 1;
1299 data.dsize = (strlen_w(um) + 1) * sizeof (smb_ucs2_t);
1300 data.dptr = (void *)um;
1302 if (tdb_store(global_mt_ent.mangle_tdb, key, data, TDB_INSERT) != TDB_SUCCESS)
1304 DEBUG(0, ("mangle: database store error: %s\n",
1305 tdb_errorstr(global_mt_ent.mangle_tdb)));
1309 /* store the mangled entry with long key*/
1310 pull_ucs2(NULL, longname, um, sizeof(longname), 0, STR_TERMINATE);
1311 slprintf(keystr, sizeof(keystr)-1, "%s%s", LONG_PREFIX, longname);
1313 key.dsize = strlen (keystr) + 1;
1314 data.dsize = strlen(mufname +1);
1315 data.dptr = mufname;
1316 if (tdb_store(global_mt_ent.mangle_tdb, key, data, TDB_INSERT) != TDB_SUCCESS)
1318 DEBUG(0, ("mangle: store failed: %s\n",
1319 tdb_errorstr(global_mt_ent.mangle_tdb)));
1321 /* try to delete the mangled key entry to avoid later inconsistency */
1322 slprintf(keystr, sizeof(keystr)-1, "%s%s", MANGLED_PREFIX, mufname);
1324 key.dsize = strlen (keystr) + 1;
1325 if (!tdb_delete(global_mt_ent.mangle_tdb, key))
1327 DEBUG(0, ("mangle: severe error, mangled tdb may be inconsistent!\n"));
1335 DEBUG(0,("mangle: out of memory!\n"));
1339 data.dptr = (char *)&c;
1340 data.dsize = sizeof(uint32);
1341 if(!tdb_store(global_mt_ent.mangle_tdb, klock, data, TDB_INSERT))
1343 DEBUG(0, ("mangle: store failed: %s\n",
1344 tdb_errorstr(global_mt_ent.mangle_tdb)));
1345 /* try to delete the mangled and long key entry to avoid later inconsistency */
1346 slprintf(keystr, sizeof(keystr)-1, "%s%s", MANGLED_PREFIX, mufname);
1348 key.dsize = strlen (keystr) + 1;
1349 if (!tdb_delete(global_mt_ent.mangle_tdb, key))
1351 DEBUG(0, ("mangle: severe error, mangled tdb may be inconsistent!\n"));
1353 slprintf(keystr, sizeof(keystr)-1, "%s%s", LONG_PREFIX, longname);
1355 key.dsize = strlen (keystr) + 1;
1356 if (!tdb_delete(global_mt_ent.mangle_tdb, key))
1358 DEBUG(0, ("mangle: severe error, mangled tdb may be inconsistent!\n"));
1364 tdb_chainunlock(global_mt_ent.mangle_tdb, klock);
1368 p = (smb_ucs2_t *)malloc(data.dsize*sizeof(smb_ucs2_t));
1371 DEBUG(0,("mangle: out of memory!\n"));
1374 dos_to_ucs2(NULL, p, data.dptr, data.dsize*sizeof(smb_ucs2_t), STR_TERMINATE);
1379 pref_len = strlen_w(p) + 1; /* terminator counted on purpose, will contain '.' */
1380 ext_len = strlen_w(ext);
1381 mangled = (smb_ucs2_t *)malloc((pref_len + ext_len + 1)*sizeof(smb_ucs2_t));
1384 DEBUG(0,("mangle: out of memory!\n"));
1387 strncpy_w (mangled, p, pref_len);
1388 mangled[pref_len] = UCS2_CHAR('.');
1389 mangled[pref_len + 1] = 0;
1390 strncat_w (mangled, ext, ext_len);
1394 mangled = strdup_w(p);
1397 DEBUG(0,("mangle: out of memory!\n"));
1403 if (tclock) tdb_chainunlock(global_mt_ent.mangle_tdb, klock);
1413 #ifdef TEST_MANGLE_CODE
1415 #define LONG "this_is_a_long_file_name"
1416 #define LONGM "this_~01"
1417 #define SHORT "short"
1418 #define SHORTM "short~01"
1422 #define EXTFAIL "longext"
1424 static void unmangle_test (char *name, char *ext)
1426 smb_ucs2_t ucs2_name[2048];
1430 push_ucs2(NULL, ucs2_name, name, sizeof(ucs2_name), STR_TERMINATE);
1433 strncat_wa(ucs2_name, ".", 1);
1434 strncat_wa(ucs2_name, ext, strlen(ext));
1436 retstr = unmangle(ucs2_name);
1437 if(retstr) pull_ucs2(NULL, unix_name, retstr, sizeof(unix_name), 0, STR_TERMINATE);
1438 else unix_name[0] = 0;
1439 if (ext) printf ("[%s.%s] ---> [%s]\n", name, ext, unix_name);
1440 else printf ("[%s] ---> [%s]\n", name, unix_name);
1444 static void mangle_test (char *name, char *ext)
1446 smb_ucs2_t ucs2_name[2048];
1450 push_ucs2(NULL, ucs2_name, name, sizeof(ucs2_name), STR_TERMINATE);
1453 strncat_wa(ucs2_name, ".", 1);
1454 strncat_wa(ucs2_name, ext, strlen(ext));
1456 retstr = _mangle(ucs2_name);
1457 if(retstr) pull_ucs2(NULL, unix_name, retstr, sizeof(unix_name), 0, STR_TERMINATE);
1458 else unix_name[0] = 0;
1459 if (ext) printf ("[%s.%s] ---> [%s]\n", name, ext, unix_name);
1460 else printf ("[%s] ---> [%s]\n", name, unix_name);
1464 void mangle_test_code(void)
1466 /* unmangle every */
1467 unmangle_test (LONG, NULL);
1468 unmangle_test (LONG, EXT1);
1469 unmangle_test (LONG, EXT2);
1470 unmangle_test (LONG, EXT3);
1471 unmangle_test (LONG, EXTFAIL);
1473 unmangle_test (LONGM, NULL);
1474 unmangle_test (LONGM, EXT1);
1475 unmangle_test (LONGM, EXT2);
1476 unmangle_test (LONGM, EXT3);
1477 unmangle_test (LONGM, EXTFAIL);
1479 unmangle_test (SHORT, NULL);
1480 unmangle_test (SHORT, EXT1);
1481 unmangle_test (SHORT, EXT2);
1482 unmangle_test (SHORT, EXT3);
1483 unmangle_test (SHORT, EXTFAIL);
1485 unmangle_test (SHORTM, NULL);
1486 unmangle_test (SHORTM, EXT1);
1487 unmangle_test (SHORTM, EXT2);
1488 unmangle_test (SHORTM, EXT3);
1489 unmangle_test (SHORTM, EXTFAIL);
1492 mangle_test (LONG, NULL);
1493 mangle_test (LONG, EXT1);
1494 mangle_test (LONG, EXT2);
1495 mangle_test (LONG, EXT3);
1496 mangle_test (LONG, EXTFAIL);
1498 mangle_test (LONGM, NULL);
1499 mangle_test (LONGM, EXT1);
1500 mangle_test (LONGM, EXT2);
1501 mangle_test (LONGM, EXT3);
1502 mangle_test (LONGM, EXTFAIL);
1504 mangle_test (SHORT, NULL);
1505 mangle_test (SHORT, EXT1);
1506 mangle_test (SHORT, EXT2);
1507 mangle_test (SHORT, EXT3);
1508 mangle_test (SHORT, EXTFAIL);
1510 mangle_test (SHORTM, NULL);
1511 mangle_test (SHORTM, EXT1);
1512 mangle_test (SHORTM, EXT2);
1513 mangle_test (SHORTM, EXT3);
1514 mangle_test (SHORTM, EXTFAIL);
1516 /* unmangle again every */
1517 unmangle_test (LONG, NULL);
1518 unmangle_test (LONG, EXT1);
1519 unmangle_test (LONG, EXT2);
1520 unmangle_test (LONG, EXT3);
1521 unmangle_test (LONG, EXTFAIL);
1523 unmangle_test (LONGM, NULL);
1524 unmangle_test (LONGM, EXT1);
1525 unmangle_test (LONGM, EXT2);
1526 unmangle_test (LONGM, EXT3);
1527 unmangle_test (LONGM, EXTFAIL);
1529 unmangle_test (SHORT, NULL);
1530 unmangle_test (SHORT, EXT1);
1531 unmangle_test (SHORT, EXT2);
1532 unmangle_test (SHORT, EXT3);
1533 unmangle_test (SHORT, EXTFAIL);
1535 unmangle_test (SHORTM, NULL);
1536 unmangle_test (SHORTM, EXT1);
1537 unmangle_test (SHORTM, EXT2);
1538 unmangle_test (SHORTM, EXT3);
1539 unmangle_test (SHORTM, EXTFAIL);
1542 #endif /* TEST_MANGLE_CODE */