2 Unix SMB/Netbios implementation.
4 filename handling routines
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.
24 extern int DEBUGLEVEL;
25 extern BOOL case_sensitive;
26 extern BOOL case_preserve;
27 extern BOOL short_case_preserve;
28 extern fstring remote_machine;
29 extern BOOL use_mangled_map;
31 static BOOL scan_directory(char *path, char *name,connection_struct *conn,BOOL docache);
33 /****************************************************************************
34 Check if two filenames are equal.
35 This needs to be careful about whether we are case sensitive.
36 ****************************************************************************/
37 static BOOL fname_equal(char *name1, char *name2)
39 int l1 = strlen(name1);
40 int l2 = strlen(name2);
42 /* handle filenames ending in a single dot */
43 if (l1-l2 == 1 && name1[l1-1] == '.' && lp_strip_dot())
47 ret = fname_equal(name1,name2);
52 if (l2-l1 == 1 && name2[l2-1] == '.' && lp_strip_dot())
56 ret = fname_equal(name1,name2);
61 /* now normal filename handling */
63 return(strcmp(name1,name2) == 0);
65 return(strequal(name1,name2));
69 /****************************************************************************
70 Mangle the 2nd name and check if it is then equal to the first name.
71 ****************************************************************************/
72 static BOOL mangled_equal(char *name1, char *name2)
76 if (is_8_3(name2, True))
79 pstrcpy(tmpname,name2);
80 mangle_name_83(tmpname);
82 return(strequal(name1,tmpname));
85 /****************************************************************************
86 Stat cache code used in unix_convert.
87 *****************************************************************************/
89 static int global_stat_cache_lookups;
90 static int global_stat_cache_misses;
91 static int global_stat_cache_hits;
93 /****************************************************************************
94 Stat cache statistics code.
95 *****************************************************************************/
97 void print_stat_cache_statistics(void)
101 if(global_stat_cache_lookups == 0)
104 eff = (100.0* (double)global_stat_cache_hits)/(double)global_stat_cache_lookups;
106 DEBUG(0,("stat cache stats: lookups = %d, hits = %d, misses = %d, \
107 stat cache was %f%% effective.\n", global_stat_cache_lookups,
108 global_stat_cache_hits, global_stat_cache_misses, eff ));
115 pstring translated_name;
118 #define MAX_STAT_CACHE_SIZE 50
120 static ubi_dlList stat_cache = { NULL, (ubi_dlNodePtr)&stat_cache, 0};
122 /****************************************************************************
123 Compare a pathname to a name in the stat cache - of a given length.
124 Note - this code always checks that the next character in the pathname
125 is either a '/' character, or a '\0' character - to ensure we only
126 match *full* pathname components. Note we don't need to handle case
127 here, if we're case insensitive the stat cache orig names are all upper
129 *****************************************************************************/
131 static BOOL stat_name_equal_len( char *stat_name, char *orig_name, int len)
133 BOOL matched = (memcmp( stat_name, orig_name, len) == 0);
134 if(orig_name[len] != '/' && orig_name[len] != '\0')
140 /****************************************************************************
141 Add an entry into the stat cache.
142 *****************************************************************************/
144 static void stat_cache_add( char *full_orig_name, char *orig_translated_path)
146 stat_cache_entry *scp;
148 pstring translated_path;
151 if (!lp_stat_cache()) return;
153 namelen = strlen(orig_translated_path);
156 * Don't cache trivial valid directory entries.
158 if((*full_orig_name == '\0') || (strcmp(full_orig_name, ".") == 0) ||
159 (strcmp(full_orig_name, "..") == 0))
163 * If we are in case insentive mode, we need to
164 * store names that need no translation - else, it
168 if(case_sensitive && (strcmp(full_orig_name, orig_translated_path) == 0))
172 * Remove any trailing '/' characters from the
176 pstrcpy(translated_path, orig_translated_path);
177 if(translated_path[namelen-1] == '/') {
178 translated_path[namelen-1] = '\0';
183 * We will only replace namelen characters
185 * StrnCpy always null terminates.
188 StrnCpy(orig_name, full_orig_name, namelen);
190 strupper( orig_name );
193 * Check this name doesn't exist in the cache before we
197 for( scp = (stat_cache_entry *)ubi_dlFirst( &stat_cache); scp;
198 scp = (stat_cache_entry *)ubi_dlNext( scp )) {
199 if((strcmp( scp->orig_name, orig_name) == 0) &&
200 (strcmp( scp->translated_name, translated_path) == 0)) {
202 * Name does exist - promote it.
204 if( (stat_cache_entry *)ubi_dlFirst( &stat_cache) != scp ) {
205 ubi_dlRemThis( &stat_cache, scp);
206 ubi_dlAddHead( &stat_cache, scp);
212 if((scp = (stat_cache_entry *)malloc(sizeof(stat_cache_entry))) == NULL) {
213 DEBUG(0,("stat_cache_add: Out of memory !\n"));
217 pstrcpy(scp->orig_name, orig_name);
218 pstrcpy(scp->translated_name, translated_path);
219 scp->name_len = namelen;
221 ubi_dlAddHead( &stat_cache, scp);
223 DEBUG(10,("stat_cache_add: Added entry %s -> %s\n", scp->orig_name, scp->translated_name ));
225 if(ubi_dlCount(&stat_cache) > lp_stat_cache_size()) {
226 scp = (stat_cache_entry *)ubi_dlRemTail( &stat_cache );
232 /****************************************************************************
233 Look through the stat cache for an entry - promote it to the top if found.
234 Return True if we translated (and did a scuccessful stat on) the entire name.
235 *****************************************************************************/
237 static BOOL stat_cache_lookup( char *name, char *dirpath, char **start, SMB_STRUCT_STAT *pst)
239 stat_cache_entry *scp;
240 stat_cache_entry *longest_hit = NULL;
244 if (!lp_stat_cache()) return False;
246 namelen = strlen(name);
249 global_stat_cache_lookups++;
252 * Don't lookup trivial valid directory entries.
254 if((*name == '\0') || (strcmp(name, ".") == 0) || (strcmp(name, "..") == 0)) {
255 global_stat_cache_misses++;
259 pstrcpy(chk_name, name);
261 strupper( chk_name );
263 for( scp = (stat_cache_entry *)ubi_dlFirst( &stat_cache); scp;
264 scp = (stat_cache_entry *)ubi_dlNext( scp )) {
265 if(scp->name_len <= namelen) {
266 if(stat_name_equal_len(scp->orig_name, chk_name, scp->name_len)) {
267 if((longest_hit == NULL) || (longest_hit->name_len <= scp->name_len))
273 if(longest_hit == NULL) {
274 DEBUG(10,("stat_cache_lookup: cache miss on %s\n", name));
275 global_stat_cache_misses++;
279 global_stat_cache_hits++;
281 DEBUG(10,("stat_cache_lookup: cache hit for name %s. %s -> %s\n",
282 name, longest_hit->orig_name, longest_hit->translated_name ));
285 * longest_hit is the longest match we got in the list.
286 * Check it exists - if so, overwrite the original name
287 * and then promote it to the top.
290 if(dos_stat( longest_hit->translated_name, pst) != 0) {
292 * Discard this entry.
294 ubi_dlRemThis( &stat_cache, longest_hit);
295 free((char *)longest_hit);
299 memcpy(name, longest_hit->translated_name, longest_hit->name_len);
300 if( (stat_cache_entry *)ubi_dlFirst( &stat_cache) != longest_hit ) {
301 ubi_dlRemThis( &stat_cache, longest_hit);
302 ubi_dlAddHead( &stat_cache, longest_hit);
305 *start = &name[longest_hit->name_len];
309 StrnCpy( dirpath, longest_hit->translated_name, name - (*start));
311 return (namelen == longest_hit->name_len);
314 /****************************************************************************
315 This routine is called to convert names from the dos namespace to unix
316 namespace. It needs to handle any case conversions, mangling, format
319 We assume that we have already done a chdir() to the right "root" directory
322 The function will return False if some part of the name except for the last
323 part cannot be resolved
325 If the saved_last_component != 0, then the unmodified last component
326 of the pathname is returned there. This is used in an exceptional
327 case in reply_mv (so far). If saved_last_component == 0 then nothing
330 The bad_path arg is set to True if the filename walk failed. This is
331 used to pick the correct error code to return between ENOENT and ENOTDIR
332 as Windows applications depend on ERRbadpath being returned if a component
333 of a pathname does not exist.
334 ****************************************************************************/
336 BOOL unix_convert(char *name,connection_struct *conn,char *saved_last_component,
337 BOOL *bad_path, SMB_STRUCT_STAT *pst)
343 BOOL component_was_mangled = False;
344 BOOL name_has_wildcard = False;
346 /* Andrew's conservative code... JRA. */
347 extern char magic_char;
350 DEBUG(5, ("unix_convert called on file \"%s\"\n", name));
358 if(saved_last_component)
359 *saved_last_component = 0;
362 * Convert to basic unix format - removing \ chars and cleaning it up.
366 unix_clean_name(name);
369 * Names must be relative to the root of the service - trim any leading /.
370 * also trim trailing /'s.
373 trim_string(name,"/","/");
376 * If we trimmed down to a single '\0' character
377 * then we should use the "." directory to avoid
378 * searching the cache, but not if we are in a
382 if (!*name && (!conn -> printer)) {
388 * Ensure saved_last_component is valid even if file exists.
391 if(saved_last_component) {
392 end = strrchr(name, '/');
394 pstrcpy(saved_last_component, end + 1);
396 pstrcpy(saved_last_component, name);
399 if (!case_sensitive &&
400 (!case_preserve || (is_8_3(name, False) && !short_case_preserve)))
404 * Check if it's a printer file.
407 if ((! *name) || strchr(name,'/') || !is_8_3(name, True)) {
410 slprintf(name2,sizeof(name2)-1,"%.6s.XXXXXX",remote_machine);
416 for (s=name2 ; *s ; s++)
417 if (!issafe(*s)) *s = '_';
418 pstrcpy(name,(char *)smbd_mktemp(name2));
424 * If we trimmed down to a single '\0' character
425 * then we will be using the "." directory.
426 * As we know this is valid we can return true here.
433 while (strncmp(start,"./",2) == 0)
436 pstrcpy(orig_path, name);
438 if(stat_cache_lookup( name, dirpath, &start, &st)) {
445 * stat the name - if it exists then we are all done!
448 if (dos_stat(name,&st) == 0) {
449 stat_cache_add(orig_path, name);
450 DEBUG(5,("conversion finished %s -> %s\n",orig_path, name));
456 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n",
457 name, dirpath, start));
460 * A special case - if we don't have any mangling chars and are case
461 * sensitive then searching won't help.
464 if (case_sensitive && !is_mangled(name) &&
465 !lp_strip_dot() && !use_mangled_map)
468 if(strchr(start,'?') || strchr(start,'*'))
469 name_has_wildcard = True;
472 * is_mangled() was changed to look at an entire pathname, not
473 * just a component. JRA.
476 if(is_mangled(start))
477 component_was_mangled = True;
480 /* Keep Andrew's conservative code around, just in case. JRA. */
481 /* this is an extremely conservative test for mangled names. */
482 if (strchr(start,magic_char))
483 component_was_mangled = True;
487 * Now we need to recursively match the name against the real
488 * directory structure.
492 * Match each part of the path name separately, trying the names
493 * as is first, then trying to scan the directory for matching names.
496 for (; start ; start = (end?end+1:(char *)NULL)) {
498 * Pinpoint the end of this section of the filename.
500 end = strchr(start, '/');
503 * Chop the name at this point.
508 if(saved_last_component != 0)
509 pstrcpy(saved_last_component, end ? end + 1 : start);
512 * Check if the name exists up to this point.
514 if (dos_stat(name, &st) == 0) {
516 * It exists. it must either be a directory or this must be
517 * the last part of the path for it to be OK.
519 if (end && !(st.st_mode & S_IFDIR)) {
521 * An intermediate part of the name isn't a directory.
523 DEBUG(5,("Not a dir %s\n",start));
534 * Remember the rest of the pathname so it can be restored
542 * Try to find this part of the path in the directory.
545 if (strchr(start,'?') || strchr(start,'*') ||
546 !scan_directory(dirpath, start, conn, end?True:False)) {
549 * An intermediate part of the name can't be found.
551 DEBUG(5,("Intermediate not found %s\n",start));
555 * We need to return the fact that the intermediate
556 * name resolution failed. This is used to return an
557 * error of ERRbadpath rather than ERRbadfile. Some
558 * Windows applications depend on the difference between
566 * Just the last part of the name doesn't exist.
567 * We may need to strupper() or strlower() it in case
568 * this conversion is being used for file creation
569 * purposes. If the filename is of mixed case then
570 * don't normalise it.
573 if (!case_preserve && (!strhasupper(start) || !strhaslower(start)))
577 * check on the mangled stack to see if we can recover the
578 * base of the filename.
581 if (is_mangled(start)) {
582 check_mangled_cache( start );
585 DEBUG(5,("New file %s\n",start));
590 * Restore the rest of the string.
593 pstrcpy(start+strlen(start)+1,rest);
594 end = start + strlen(start);
599 * Add to the dirpath that we have resolved so far.
602 pstrcat(dirpath,"/");
604 pstrcat(dirpath,start);
607 * Don't cache a name with mangled or wildcard components
608 * as this can change the size.
611 if(!component_was_mangled && !name_has_wildcard)
612 stat_cache_add(orig_path, dirpath);
615 * Restore the / that we wiped out earlier.
622 * Don't cache a name with mangled or wildcard components
623 * as this can change the size.
626 if(!component_was_mangled && !name_has_wildcard)
627 stat_cache_add(orig_path, name);
630 * The name has been resolved.
633 DEBUG(5,("conversion finished %s -> %s\n",orig_path, name));
638 /****************************************************************************
639 check a filename - possibly caling reducename
641 This is called by every routine before it allows an operation on a filename.
642 It does any final confirmation necessary to ensure that the filename is
643 a valid one for the user to access.
644 ****************************************************************************/
645 BOOL check_name(char *name,connection_struct *conn)
651 if (IS_VETO_PATH(conn, name)) {
652 DEBUG(5,("file path name %s vetoed\n",name));
656 ret = reduce_name(name,conn->connectpath,lp_widelinks(SNUM(conn)));
658 /* Check if we are allowing users to follow symlinks */
659 /* Patch from David Clerc <David.Clerc@cui.unige.ch>
660 University of Geneva */
663 if (!lp_symlinks(SNUM(conn)))
665 SMB_STRUCT_STAT statbuf;
666 if ( (dos_lstat(name,&statbuf) != -1) &&
667 (S_ISLNK(statbuf.st_mode)) )
669 DEBUG(3,("check_name: denied: file path name %s is a symlink\n",name));
676 DEBUG(5,("check_name on %s failed\n",name));
682 /****************************************************************************
683 scan a directory to find a filename, matching without case sensitivity
685 If the name looks like a mangled name then try via the mangling functions
686 ****************************************************************************/
687 static BOOL scan_directory(char *path, char *name,connection_struct *conn,BOOL docache)
694 mangled = is_mangled(name);
696 /* handle null paths */
700 if (docache && (dname = DirCacheCheck(path,name,SNUM(conn)))) {
701 pstrcpy(name, dname);
706 * The incoming name can be mangled, and if we de-mangle it
707 * here it will not compare correctly against the filename (name2)
708 * read from the directory and then mangled by the name_map_mangle()
709 * call. We need to mangle both names or neither.
713 mangled = !check_mangled_cache( name );
715 /* open the directory */
716 if (!(cur_dir = OpenDir(conn, path, True)))
718 DEBUG(3,("scan dir didn't open dir [%s]\n",path));
722 /* now scan for matching names */
723 while ((dname = ReadDirName(cur_dir)))
726 (strequal(dname,".") || strequal(dname,"..")))
729 pstrcpy(name2,dname);
730 if (!name_map_mangle(name2,False,True,SNUM(conn)))
733 if ((mangled && mangled_equal(name,name2))
734 || fname_equal(name, name2))
736 /* we've found the file, change it's name and return */
737 if (docache) DirCacheAdd(path,name,dname,SNUM(conn));
738 pstrcpy(name, dname);