4 Unix SMB/Netbios implementation.
6 filename handling routines
7 Copyright (C) Andrew Tridgell 1992-1998
8 Copyright (C) Jeremy Allison 1999-200
9 Copyright (C) Ying Chen 2000
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 * New hash table stat cache code added by Ying Chen.
32 extern int DEBUGLEVEL;
33 extern BOOL case_sensitive;
34 extern BOOL case_preserve;
35 extern BOOL short_case_preserve;
36 extern fstring remote_machine;
37 extern BOOL use_mangled_map;
39 static BOOL scan_directory(char *path, char *name,connection_struct *conn,BOOL docache);
41 /****************************************************************************
42 Check if two filenames are equal.
43 This needs to be careful about whether we are case sensitive.
44 ****************************************************************************/
45 static BOOL fname_equal(char *name1, char *name2)
47 int l1 = strlen(name1);
48 int l2 = strlen(name2);
50 /* handle filenames ending in a single dot */
51 if (l1-l2 == 1 && name1[l1-1] == '.' && lp_strip_dot())
55 ret = fname_equal(name1,name2);
60 if (l2-l1 == 1 && name2[l2-1] == '.' && lp_strip_dot())
64 ret = fname_equal(name1,name2);
69 /* now normal filename handling */
71 return(strcmp(name1,name2) == 0);
73 return(strequal(name1,name2));
77 /****************************************************************************
78 Mangle the 2nd name and check if it is then equal to the first name.
79 ****************************************************************************/
80 static BOOL mangled_equal(char *name1, char *name2)
84 if (is_8_3(name2, True))
87 pstrcpy(tmpname,name2);
88 mangle_name_83(tmpname);
90 return(strequal(name1,tmpname));
94 /****************************************************************************
95 This routine is called to convert names from the dos namespace to unix
96 namespace. It needs to handle any case conversions, mangling, format
99 We assume that we have already done a chdir() to the right "root" directory
102 The function will return False if some part of the name except for the last
103 part cannot be resolved
105 If the saved_last_component != 0, then the unmodified last component
106 of the pathname is returned there. This is used in an exceptional
107 case in reply_mv (so far). If saved_last_component == 0 then nothing
110 The bad_path arg is set to True if the filename walk failed. This is
111 used to pick the correct error code to return between ENOENT and ENOTDIR
112 as Windows applications depend on ERRbadpath being returned if a component
113 of a pathname does not exist.
115 On exit from unix_convert, if *pst was not null, then the file stat
116 struct will be returned if the file exists and was found, if not this
117 stat struct will be filled with zeros (and this can be detected by checking
118 for nlinks = 0, which can never be true for any file).
119 ****************************************************************************/
121 BOOL unix_convert(char *name,connection_struct *conn,char *saved_last_component,
122 BOOL *bad_path, SMB_STRUCT_STAT *pst)
128 BOOL component_was_mangled = False;
129 BOOL name_has_wildcard = False;
131 /* Andrew's conservative code... JRA. */
132 extern char magic_char;
139 if(saved_last_component)
140 *saved_last_component = 0;
143 /* we don't ever use the filenames on a printer share as a
144 filename - so don't convert them */
148 DEBUG(5, ("unix_convert called on file \"%s\"\n", name));
151 * Convert to basic unix format - removing \ chars and cleaning it up.
155 unix_clean_name(name);
158 * Names must be relative to the root of the service - trim any leading /.
159 * also trim trailing /'s.
162 trim_string(name,"/","/");
165 * If we trimmed down to a single '\0' character
166 * then we should use the "." directory to avoid
167 * searching the cache, but not if we are in a
177 * Ensure saved_last_component is valid even if file exists.
180 if(saved_last_component) {
181 end = strrchr(name, '/');
183 pstrcpy(saved_last_component, end + 1);
185 pstrcpy(saved_last_component, name);
188 if (!case_sensitive &&
189 (!case_preserve || (is_8_3(name, False) && !short_case_preserve)))
193 * If we trimmed down to a single '\0' character
194 * then we will be using the "." directory.
195 * As we know this is valid we can return true here.
202 while (strncmp(start,"./",2) == 0)
205 pstrcpy(orig_path, name);
207 if(stat_cache_lookup(conn, name, dirpath, &start, &st)) {
213 * stat the name - if it exists then we are all done!
216 if (vfs_stat(conn,name,&st) == 0) {
217 stat_cache_add(orig_path, name);
218 DEBUG(5,("conversion finished %s -> %s\n",orig_path, name));
223 DEBUG(5,("unix_convert begin: name = %s, dirpath = %s, start = %s\n",
224 name, dirpath, start));
227 * A special case - if we don't have any mangling chars and are case
228 * sensitive then searching won't help.
231 if (case_sensitive && !is_mangled(name) &&
232 !lp_strip_dot() && !use_mangled_map)
235 name_has_wildcard = ms_has_wild(start);
238 * is_mangled() was changed to look at an entire pathname, not
239 * just a component. JRA.
242 if(is_mangled(start))
243 component_was_mangled = True;
246 /* Keep Andrew's conservative code around, just in case. JRA. */
247 /* this is an extremely conservative test for mangled names. */
248 if (strchr(start,magic_char))
249 component_was_mangled = True;
253 * Now we need to recursively match the name against the real
254 * directory structure.
258 * Match each part of the path name separately, trying the names
259 * as is first, then trying to scan the directory for matching names.
262 for (; start ; start = (end?end+1:(char *)NULL)) {
264 * Pinpoint the end of this section of the filename.
266 end = strchr(start, '/');
269 * Chop the name at this point.
274 if(saved_last_component != 0)
275 pstrcpy(saved_last_component, end ? end + 1 : start);
278 * Check if the name exists up to this point.
281 if (vfs_stat(conn,name, &st) == 0) {
283 * It exists. it must either be a directory or this must be
284 * the last part of the path for it to be OK.
286 if (end && !(st.st_mode & S_IFDIR)) {
288 * An intermediate part of the name isn't a directory.
290 DEBUG(5,("Not a dir %s\n",start));
298 /* Stat failed - ensure we don't use it. */
303 * Remember the rest of the pathname so it can be restored
311 * Try to find this part of the path in the directory.
314 if (ms_has_wild(start) || !scan_directory(dirpath, start, conn, end?True:False)) {
317 * An intermediate part of the name can't be found.
319 DEBUG(5,("Intermediate not found %s\n",start));
323 * We need to return the fact that the intermediate
324 * name resolution failed. This is used to return an
325 * error of ERRbadpath rather than ERRbadfile. Some
326 * Windows applications depend on the difference between
334 * Just the last part of the name doesn't exist.
335 * We may need to strupper() or strlower() it in case
336 * this conversion is being used for file creation
337 * purposes. If the filename is of mixed case then
338 * don't normalise it.
341 if (!case_preserve && (!strhasupper(start) || !strhaslower(start)))
345 * check on the mangled stack to see if we can recover the
346 * base of the filename.
349 if (is_mangled(start)) {
350 check_mangled_cache( start );
353 DEBUG(5,("New file %s\n",start));
358 * Restore the rest of the string.
361 pstrcpy(start+strlen(start)+1,rest);
362 end = start + strlen(start);
367 * Add to the dirpath that we have resolved so far.
370 pstrcat(dirpath,"/");
372 pstrcat(dirpath,start);
375 * Don't cache a name with mangled or wildcard components
376 * as this can change the size.
379 if(!component_was_mangled && !name_has_wildcard)
380 stat_cache_add(orig_path, dirpath);
383 * Restore the / that we wiped out earlier.
390 * Don't cache a name with mangled or wildcard components
391 * as this can change the size.
394 if(!component_was_mangled && !name_has_wildcard)
395 stat_cache_add(orig_path, name);
398 * If we ended up resolving the entire path then return a valid
399 * stat struct if we got one.
402 if (VALID_STAT(st) && (strlen(orig_path) == strlen(name)))
406 * The name has been resolved.
409 DEBUG(5,("conversion finished %s -> %s\n",orig_path, name));
414 /****************************************************************************
415 check a filename - possibly caling reducename
417 This is called by every routine before it allows an operation on a filename.
418 It does any final confirmation necessary to ensure that the filename is
419 a valid one for the user to access.
420 ****************************************************************************/
421 BOOL check_name(char *name,connection_struct *conn)
427 if (IS_VETO_PATH(conn, name)) {
428 DEBUG(5,("file path name %s vetoed\n",name));
432 ret = reduce_name(conn,name,conn->connectpath,lp_widelinks(SNUM(conn)));
434 /* Check if we are allowing users to follow symlinks */
435 /* Patch from David Clerc <David.Clerc@cui.unige.ch>
436 University of Geneva */
439 if (!lp_symlinks(SNUM(conn))) {
440 SMB_STRUCT_STAT statbuf;
441 if ( (conn->vfs_ops.lstat(conn,dos_to_unix(name,False),&statbuf) != -1) &&
442 (S_ISLNK(statbuf.st_mode)) ) {
443 DEBUG(3,("check_name: denied: file path name %s is a symlink\n",name));
450 DEBUG(5,("check_name on %s failed\n",name));
456 /****************************************************************************
457 scan a directory to find a filename, matching without case sensitivity
459 If the name looks like a mangled name then try via the mangling functions
460 ****************************************************************************/
461 static BOOL scan_directory(char *path, char *name,connection_struct *conn,BOOL docache)
468 mangled = is_mangled(name);
470 /* handle null paths */
474 if (docache && (dname = DirCacheCheck(path,name,SNUM(conn)))) {
475 pstrcpy(name, dname);
480 * The incoming name can be mangled, and if we de-mangle it
481 * here it will not compare correctly against the filename (name2)
482 * read from the directory and then mangled by the name_map_mangle()
483 * call. We need to mangle both names or neither.
487 mangled = !check_mangled_cache( name );
489 /* open the directory */
490 if (!(cur_dir = OpenDir(conn, path, True))) {
491 DEBUG(3,("scan dir didn't open dir [%s]\n",path));
495 /* now scan for matching names */
496 while ((dname = ReadDirName(cur_dir))) {
497 if (*dname == '.' && (strequal(dname,".") || strequal(dname,"..")))
500 pstrcpy(name2,dname);
501 if (!name_map_mangle(name2,False,True,SNUM(conn)))
504 if ((mangled && mangled_equal(name,name2)) || fname_equal(name, name2)) {
505 /* we've found the file, change it's name and return */
507 DirCacheAdd(path,name,dname,SNUM(conn));
508 pstrcpy(name, dname);