2 Unix SMB/CIFS implementation.
3 filename handling routines
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 1999-200
6 Copyright (C) Ying Chen 2000
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 2 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, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * New hash table stat cache code added by Ying Chen.
29 extern BOOL case_sensitive
;
30 extern BOOL case_preserve
;
31 extern BOOL short_case_preserve
;
32 extern BOOL use_mangled_map
;
34 static BOOL
scan_directory(const char *path
, char *name
,size_t maxlength
,
35 connection_struct
*conn
,BOOL docache
);
37 /****************************************************************************
38 Check if two filenames are equal.
39 This needs to be careful about whether we are case sensitive.
40 ****************************************************************************/
42 static BOOL
fname_equal(char *name1
, char *name2
)
44 /* Normal filename handling */
46 return(strcmp(name1
,name2
) == 0);
48 return(strequal(name1
,name2
));
51 /****************************************************************************
52 Mangle the 2nd name and check if it is then equal to the first name.
53 ****************************************************************************/
55 static BOOL
mangled_equal(char *name1
, const char *name2
, int snum
)
59 pstrcpy(tmpname
, name2
);
60 mangle_map(tmpname
, True
, False
, snum
);
61 return strequal(name1
, tmpname
);
64 /****************************************************************************
65 This routine is called to convert names from the dos namespace to unix
66 namespace. It needs to handle any case conversions, mangling, format
69 We assume that we have already done a chdir() to the right "root" directory
72 The function will return False if some part of the name except for the last
73 part cannot be resolved
75 If the saved_last_component != 0, then the unmodified last component
76 of the pathname is returned there. This is used in an exceptional
77 case in reply_mv (so far). If saved_last_component == 0 then nothing
80 The bad_path arg is set to True if the filename walk failed. This is
81 used to pick the correct error code to return between ENOENT and ENOTDIR
82 as Windows applications depend on ERRbadpath being returned if a component
83 of a pathname does not exist.
85 On exit from unix_convert, if *pst was not null, then the file stat
86 struct will be returned if the file exists and was found, if not this
87 stat struct will be filled with zeros (and this can be detected by checking
88 for nlinks = 0, which can never be true for any file).
89 ****************************************************************************/
91 BOOL
unix_convert(pstring name
,connection_struct
*conn
,char *saved_last_component
,
92 BOOL
*bad_path
, SMB_STRUCT_STAT
*pst
)
98 BOOL component_was_mangled
= False
;
99 BOOL name_has_wildcard
= False
;
105 if(saved_last_component
)
106 *saved_last_component
= 0;
109 /* we don't ever use the filenames on a printer share as a
110 filename - so don't convert them */
114 DEBUG(5, ("unix_convert called on file \"%s\"\n", name
));
117 * Convert to basic unix format - removing \ chars and cleaning it up.
121 unix_clean_name(name
);
124 * Names must be relative to the root of the service - trim any leading /.
125 * also trim trailing /'s.
128 trim_string(name
,"/","/");
131 * If we trimmed down to a single '\0' character
132 * then we should use the "." directory to avoid
133 * searching the cache, but not if we are in a
143 * Ensure saved_last_component is valid even if file exists.
146 if(saved_last_component
) {
147 end
= strrchr_m(name
, '/');
149 pstrcpy(saved_last_component
, end
+ 1);
151 pstrcpy(saved_last_component
, name
);
154 if (!case_sensitive
&& (!case_preserve
|| (mangle_is_8_3(name
, False
) && !short_case_preserve
)))
158 * If we trimmed down to a single '\0' character
159 * then we will be using the "." directory.
160 * As we know this is valid we can return true here.
167 while (strncmp(start
,"./",2) == 0)
170 pstrcpy(orig_path
, name
);
172 if(!case_sensitive
&& stat_cache_lookup(conn
, name
, dirpath
, &start
, &st
)) {
178 * stat the name - if it exists then we are all done!
181 if (vfs_stat(conn
,name
,&st
) == 0) {
182 stat_cache_add(orig_path
, name
);
183 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
188 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n", name
, dirpath
, start
));
191 * A special case - if we don't have any mangling chars and are case
192 * sensitive then searching won't help.
195 if (case_sensitive
&& !mangle_is_mangled(name
) && !use_mangled_map
)
198 name_has_wildcard
= ms_has_wild(start
);
201 * is_mangled() was changed to look at an entire pathname, not
202 * just a component. JRA.
205 if (mangle_is_mangled(start
))
206 component_was_mangled
= True
;
209 * Now we need to recursively match the name against the real
210 * directory structure.
214 * Match each part of the path name separately, trying the names
215 * as is first, then trying to scan the directory for matching names.
218 for (; start
; start
= (end
?end
+1:(char *)NULL
)) {
220 * Pinpoint the end of this section of the filename.
222 end
= strchr_m(start
, '/');
225 * Chop the name at this point.
230 if(saved_last_component
!= 0)
231 pstrcpy(saved_last_component
, end
? end
+ 1 : start
);
234 * Check if the name exists up to this point.
237 if (vfs_stat(conn
,name
, &st
) == 0) {
239 * It exists. it must either be a directory or this must be
240 * the last part of the path for it to be OK.
242 if (end
&& !(st
.st_mode
& S_IFDIR
)) {
244 * An intermediate part of the name isn't a directory.
246 DEBUG(5,("Not a dir %s\n",start
));
254 /* Stat failed - ensure we don't use it. */
259 * Remember the rest of the pathname so it can be restored
267 * Try to find this part of the path in the directory.
270 if (ms_has_wild(start
) ||
271 !scan_directory(dirpath
, start
,
272 sizeof(pstring
) - 1 - (start
- name
),
277 * An intermediate part of the name can't be found.
279 DEBUG(5,("Intermediate not found %s\n",start
));
283 * We need to return the fact that the intermediate
284 * name resolution failed. This is used to return an
285 * error of ERRbadpath rather than ERRbadfile. Some
286 * Windows applications depend on the difference between
294 * Just the last part of the name doesn't exist.
295 * We may need to strupper() or strlower() it in case
296 * this conversion is being used for file creation
297 * purposes. If the filename is of mixed case then
298 * don't normalise it.
301 if (!case_preserve
&& (!strhasupper(start
) || !strhaslower(start
)))
305 * check on the mangled stack to see if we can recover the
306 * base of the filename.
309 if (mangle_is_mangled(start
)) {
310 mangle_check_cache( start
);
313 DEBUG(5,("New file %s\n",start
));
318 * Restore the rest of the string. If the string was mangled the size
322 end
= start
+ strlen(start
);
323 if (!safe_strcat(start
, "/", sizeof(pstring
) - 1 - (start
- name
)) ||
324 !safe_strcat(start
, rest
, sizeof(pstring
) - 1 - (start
- name
))) {
330 * We just scanned for, and found the end of the path.
331 * We must return a valid stat struct if it exists.
335 if (vfs_stat(conn
,name
, &st
) == 0) {
344 * Add to the dirpath that we have resolved so far.
347 pstrcat(dirpath
,"/");
349 pstrcat(dirpath
,start
);
352 * Don't cache a name with mangled or wildcard components
353 * as this can change the size.
356 if(!component_was_mangled
&& !name_has_wildcard
)
357 stat_cache_add(orig_path
, dirpath
);
360 * Restore the / that we wiped out earlier.
367 * Don't cache a name with mangled or wildcard components
368 * as this can change the size.
371 if(!component_was_mangled
&& !name_has_wildcard
)
372 stat_cache_add(orig_path
, name
);
375 * If we ended up resolving the entire path then return a valid
376 * stat struct if we got one.
379 if (VALID_STAT(st
) && (strlen(orig_path
) == strlen(name
)))
383 * The name has been resolved.
386 DEBUG(5,("conversion finished %s -> %s\n",orig_path
, name
));
390 /****************************************************************************
391 Check a filename - possibly caling reducename.
392 This is called by every routine before it allows an operation on a filename.
393 It does any final confirmation necessary to ensure that the filename is
394 a valid one for the user to access.
395 ****************************************************************************/
397 BOOL
check_name(pstring name
,connection_struct
*conn
)
403 if (IS_VETO_PATH(conn
, name
)) {
404 if(strcmp(name
, ".") && strcmp(name
, "..")) {
405 DEBUG(5,("file path name %s vetoed\n",name
));
410 ret
= reduce_name(conn
,name
,conn
->connectpath
,lp_widelinks(SNUM(conn
)));
412 /* Check if we are allowing users to follow symlinks */
413 /* Patch from David Clerc <David.Clerc@cui.unige.ch>
414 University of Geneva */
417 if (!lp_symlinks(SNUM(conn
))) {
418 SMB_STRUCT_STAT statbuf
;
419 if ( (conn
->vfs_ops
.lstat(conn
,name
,&statbuf
) != -1) &&
420 (S_ISLNK(statbuf
.st_mode
)) ) {
421 DEBUG(3,("check_name: denied: file path name %s is a symlink\n",name
));
428 DEBUG(5,("check_name on %s failed\n",name
));
433 /****************************************************************************
434 Scan a directory to find a filename, matching without case sensitivity.
435 If the name looks like a mangled name then try via the mangling functions
436 ****************************************************************************/
438 static BOOL
scan_directory(const char *path
, char *name
, size_t maxlength
,
439 connection_struct
*conn
,BOOL docache
)
445 mangled
= mangle_is_mangled(name
);
447 /* handle null paths */
451 if (docache
&& (dname
= DirCacheCheck(path
,name
,SNUM(conn
)))) {
452 safe_strcpy(name
, dname
, maxlength
);
457 * The incoming name can be mangled, and if we de-mangle it
458 * here it will not compare correctly against the filename (name2)
459 * read from the directory and then mangled by the mangle_map()
460 * call. We need to mangle both names or neither.
464 mangled
= !mangle_check_cache( name
);
466 /* open the directory */
467 if (!(cur_dir
= OpenDir(conn
, path
, True
))) {
468 DEBUG(3,("scan dir didn't open dir [%s]\n",path
));
472 /* now scan for matching names */
473 while ((dname
= ReadDirName(cur_dir
))) {
474 if (*dname
== '.' && (strequal(dname
,".") || strequal(dname
,"..")))
478 * At this point dname is the unmangled name.
479 * name is either mangled or not, depending on the state of the "mangled"
484 * Check mangled name against mangled name, or unmangled name
485 * against unmangled name.
488 if ((mangled
&& mangled_equal(name
,dname
,SNUM(conn
))) || fname_equal(name
, dname
)) {
489 /* we've found the file, change it's name and return */
491 DirCacheAdd(path
,name
,dname
,SNUM(conn
));
492 safe_strcpy(name
, dname
, maxlength
);