2 Unix SMB/CIFS implementation.
3 Directory handling routines
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2007
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 3 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, see <http://www.gnu.org/licenses/>.
24 This module implements directory related functions for Samba.
27 /* "Special" directory offsets. */
28 #define END_OF_DIRECTORY_OFFSET ((long)-1)
29 #define START_OF_DIRECTORY_OFFSET ((long)0)
30 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
32 /* Make directory handle internals available. */
34 struct name_cache_entry
{
40 connection_struct
*conn
;
44 size_t name_cache_size
;
45 struct name_cache_entry
*name_cache
;
46 unsigned int name_cache_index
;
47 unsigned int file_number
;
51 struct dptr_struct
*next
, *prev
;
54 struct connection_struct
*conn
;
55 struct smb_Dir
*dir_hnd
;
60 bool has_wild
; /* Set to true if the wcard entry has MS wildcard characters in it. */
61 bool did_stat
; /* Optimisation for non-wcard searches. */
64 static struct bitmap
*dptr_bmap
;
65 static struct dptr_struct
*dirptrs
;
66 static int dirhandles_open
= 0;
68 #define INVALID_DPTR_KEY (-3)
70 /****************************************************************************
72 ****************************************************************************/
74 bool make_dir_struct(TALLOC_CTX
*ctx
,
84 char *mask2
= talloc_strdup(ctx
, mask
);
90 if ((mode
& aDIR
) != 0) {
95 if ((p
= strchr_m(mask2
,'.')) != NULL
) {
97 push_ascii(buf
+1,mask2
,8, 0);
98 push_ascii(buf
+9,p
+1,3, 0);
101 push_ascii(buf
+1,mask2
,11, 0);
104 memset(buf
+21,'\0',DIR_STRUCT_SIZE
-21);
106 srv_put_dos_date(buf
,22,date
);
107 SSVAL(buf
,26,size
& 0xFFFF);
108 SSVAL(buf
,28,(size
>> 16)&0xFFFF);
109 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
110 Strange, but verified on W2K3. Needed for OS/2. JRA. */
111 push_ascii(buf
+30,fname
,12, uc
? STR_UPPER
: 0);
112 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf
+30, fname
));
116 /****************************************************************************
117 Initialise the dir bitmap.
118 ****************************************************************************/
120 void init_dptrs(void)
122 static bool dptrs_init
=False
;
127 dptr_bmap
= bitmap_allocate(MAX_DIRECTORY_HANDLES
);
130 exit_server("out of memory in init_dptrs");
135 /****************************************************************************
136 Idle a dptr - the directory is closed but the control info is kept.
137 ****************************************************************************/
139 static void dptr_idle(struct dptr_struct
*dptr
)
142 DEBUG(4,("Idling dptr dnum %d\n",dptr
->dnum
));
143 TALLOC_FREE(dptr
->dir_hnd
);
147 /****************************************************************************
148 Idle the oldest dptr.
149 ****************************************************************************/
151 static void dptr_idleoldest(void)
153 struct dptr_struct
*dptr
;
156 * Go to the end of the list.
158 for(dptr
= dirptrs
; dptr
&& dptr
->next
; dptr
= dptr
->next
)
162 DEBUG(0,("No dptrs available to idle ?\n"));
167 * Idle the oldest pointer.
170 for(; dptr
; dptr
= dptr
->prev
) {
178 /****************************************************************************
179 Get the struct dptr_struct for a dir index.
180 ****************************************************************************/
182 static struct dptr_struct
*dptr_get(int key
, bool forclose
)
184 struct dptr_struct
*dptr
;
186 for(dptr
= dirptrs
; dptr
; dptr
= dptr
->next
) {
187 if(dptr
->dnum
== key
) {
188 if (!forclose
&& !dptr
->dir_hnd
) {
189 if (dirhandles_open
>= MAX_OPEN_DIRECTORIES
)
191 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key
));
192 if (!(dptr
->dir_hnd
= OpenDir(
193 NULL
, dptr
->conn
, dptr
->path
,
194 dptr
->wcard
, dptr
->attr
))) {
195 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr
->path
,
200 DLIST_PROMOTE(dirptrs
,dptr
);
207 /****************************************************************************
208 Get the dir path for a dir index.
209 ****************************************************************************/
211 char *dptr_path(int key
)
213 struct dptr_struct
*dptr
= dptr_get(key
, False
);
219 /****************************************************************************
220 Get the dir wcard for a dir index.
221 ****************************************************************************/
223 char *dptr_wcard(int key
)
225 struct dptr_struct
*dptr
= dptr_get(key
, False
);
231 /****************************************************************************
232 Get the dir attrib for a dir index.
233 ****************************************************************************/
235 uint16
dptr_attr(int key
)
237 struct dptr_struct
*dptr
= dptr_get(key
, False
);
243 /****************************************************************************
244 Close a dptr (internal func).
245 ****************************************************************************/
247 static void dptr_close_internal(struct dptr_struct
*dptr
)
249 DEBUG(4,("closing dptr key %d\n",dptr
->dnum
));
251 DLIST_REMOVE(dirptrs
, dptr
);
254 * Free the dnum in the bitmap. Remember the dnum value is always
255 * biased by one with respect to the bitmap.
258 if(bitmap_query( dptr_bmap
, dptr
->dnum
- 1) != True
) {
259 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
263 bitmap_clear(dptr_bmap
, dptr
->dnum
- 1);
265 TALLOC_FREE(dptr
->dir_hnd
);
267 /* Lanman 2 specific code */
268 SAFE_FREE(dptr
->wcard
);
269 string_set(&dptr
->path
,"");
273 /****************************************************************************
274 Close a dptr given a key.
275 ****************************************************************************/
277 void dptr_close(int *key
)
279 struct dptr_struct
*dptr
;
281 if(*key
== INVALID_DPTR_KEY
)
284 /* OS/2 seems to use -1 to indicate "close all directories" */
286 struct dptr_struct
*next
;
287 for(dptr
= dirptrs
; dptr
; dptr
= next
) {
289 dptr_close_internal(dptr
);
291 *key
= INVALID_DPTR_KEY
;
295 dptr
= dptr_get(*key
, True
);
298 DEBUG(0,("Invalid key %d given to dptr_close\n", *key
));
302 dptr_close_internal(dptr
);
304 *key
= INVALID_DPTR_KEY
;
307 /****************************************************************************
308 Close all dptrs for a cnum.
309 ****************************************************************************/
311 void dptr_closecnum(connection_struct
*conn
)
313 struct dptr_struct
*dptr
, *next
;
314 for(dptr
= dirptrs
; dptr
; dptr
= next
) {
316 if (dptr
->conn
== conn
)
317 dptr_close_internal(dptr
);
321 /****************************************************************************
322 Idle all dptrs for a cnum.
323 ****************************************************************************/
325 void dptr_idlecnum(connection_struct
*conn
)
327 struct dptr_struct
*dptr
;
328 for(dptr
= dirptrs
; dptr
; dptr
= dptr
->next
) {
329 if (dptr
->conn
== conn
&& dptr
->dir_hnd
)
334 /****************************************************************************
335 Close a dptr that matches a given path, only if it matches the spid also.
336 ****************************************************************************/
338 void dptr_closepath(char *path
,uint16 spid
)
340 struct dptr_struct
*dptr
, *next
;
341 for(dptr
= dirptrs
; dptr
; dptr
= next
) {
343 if (spid
== dptr
->spid
&& strequal(dptr
->path
,path
))
344 dptr_close_internal(dptr
);
348 /****************************************************************************
349 Try and close the oldest handle not marked for
350 expect close in the hope that the client has
351 finished with that one.
352 ****************************************************************************/
354 static void dptr_close_oldest(bool old
)
356 struct dptr_struct
*dptr
;
359 * Go to the end of the list.
361 for(dptr
= dirptrs
; dptr
&& dptr
->next
; dptr
= dptr
->next
)
365 DEBUG(0,("No old dptrs available to close oldest ?\n"));
370 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
371 * does not have expect_close set. If 'old' is false, close
372 * one of the new dnum handles.
375 for(; dptr
; dptr
= dptr
->prev
) {
376 if ((old
&& (dptr
->dnum
< 256) && !dptr
->expect_close
) ||
377 (!old
&& (dptr
->dnum
> 255))) {
378 dptr_close_internal(dptr
);
384 /****************************************************************************
385 Create a new dir ptr. If the flag old_handle is true then we must allocate
386 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
387 one byte long. If old_handle is false we allocate from the range
388 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
389 a directory handle is never zero.
390 wcard must not be zero.
391 ****************************************************************************/
393 NTSTATUS
dptr_create(connection_struct
*conn
, const char *path
, bool old_handle
, bool expect_close
,uint16 spid
,
394 const char *wcard
, bool wcard_has_wild
, uint32 attr
, struct dptr_struct
**dptr_ret
)
396 struct dptr_struct
*dptr
= NULL
;
397 struct smb_Dir
*dir_hnd
;
400 DEBUG(5,("dptr_create dir=%s\n", path
));
403 return NT_STATUS_INVALID_PARAMETER
;
406 status
= check_name(conn
,path
);
407 if (!NT_STATUS_IS_OK(status
)) {
411 dir_hnd
= OpenDir(NULL
, conn
, path
, wcard
, attr
);
413 return map_nt_error_from_unix(errno
);
416 string_set(&conn
->dirpath
,path
);
418 if (dirhandles_open
>= MAX_OPEN_DIRECTORIES
) {
422 dptr
= SMB_MALLOC_P(struct dptr_struct
);
424 DEBUG(0,("malloc fail in dptr_create.\n"));
425 TALLOC_FREE(dir_hnd
);
426 return NT_STATUS_NO_MEMORY
;
434 * This is an old-style SMBsearch request. Ensure the
435 * value we return will fit in the range 1-255.
438 dptr
->dnum
= bitmap_find(dptr_bmap
, 0);
440 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
443 * Try and close the oldest handle not marked for
444 * expect close in the hope that the client has
445 * finished with that one.
448 dptr_close_oldest(True
);
450 /* Now try again... */
451 dptr
->dnum
= bitmap_find(dptr_bmap
, 0);
452 if(dptr
->dnum
== -1 || dptr
->dnum
> 254) {
453 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr
->dnum
));
455 TALLOC_FREE(dir_hnd
);
456 return NT_STATUS_TOO_MANY_OPENED_FILES
;
462 * This is a new-style trans2 request. Allocate from
463 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
466 dptr
->dnum
= bitmap_find(dptr_bmap
, 255);
468 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
471 * Try and close the oldest handle close in the hope that
472 * the client has finished with that one. This will only
473 * happen in the case of the Win98 client bug where it leaks
477 dptr_close_oldest(False
);
479 /* Now try again... */
480 dptr
->dnum
= bitmap_find(dptr_bmap
, 255);
482 if(dptr
->dnum
== -1 || dptr
->dnum
< 255) {
483 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr
->dnum
));
485 TALLOC_FREE(dir_hnd
);
486 return NT_STATUS_TOO_MANY_OPENED_FILES
;
491 bitmap_set(dptr_bmap
, dptr
->dnum
);
493 dptr
->dnum
+= 1; /* Always bias the dnum by one - no zero dnums allowed. */
495 string_set(&dptr
->path
,path
);
497 dptr
->dir_hnd
= dir_hnd
;
499 dptr
->expect_close
= expect_close
;
500 dptr
->wcard
= SMB_STRDUP(wcard
);
502 bitmap_clear(dptr_bmap
, dptr
->dnum
- 1);
504 TALLOC_FREE(dir_hnd
);
505 return NT_STATUS_NO_MEMORY
;
507 if (lp_posix_pathnames() || (wcard
[0] == '.' && wcard
[1] == 0)) {
508 dptr
->has_wild
= True
;
510 dptr
->has_wild
= wcard_has_wild
;
515 DLIST_ADD(dirptrs
, dptr
);
517 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
518 dptr
->dnum
,path
,expect_close
));
526 /****************************************************************************
527 Wrapper functions to access the lower level directory handles.
528 ****************************************************************************/
530 int dptr_CloseDir(struct dptr_struct
*dptr
)
532 DLIST_REMOVE(dirptrs
, dptr
);
533 TALLOC_FREE(dptr
->dir_hnd
);
537 void dptr_SeekDir(struct dptr_struct
*dptr
, long offset
)
539 SeekDir(dptr
->dir_hnd
, offset
);
542 long dptr_TellDir(struct dptr_struct
*dptr
)
544 return TellDir(dptr
->dir_hnd
);
547 bool dptr_has_wild(struct dptr_struct
*dptr
)
549 return dptr
->has_wild
;
552 int dptr_dnum(struct dptr_struct
*dptr
)
557 /****************************************************************************
558 Return the next visible file name, skipping veto'd and invisible files.
559 ****************************************************************************/
561 static const char *dptr_normal_ReadDirName(struct dptr_struct
*dptr
, long *poffset
, SMB_STRUCT_STAT
*pst
)
563 /* Normal search for the next file. */
565 while ((name
= ReadDirName(dptr
->dir_hnd
, poffset
)) != NULL
) {
566 if (is_visible_file(dptr
->conn
, dptr
->path
, name
, pst
, True
)) {
573 /****************************************************************************
574 Return the next visible file name, skipping veto'd and invisible files.
575 ****************************************************************************/
577 const char *dptr_ReadDirName(TALLOC_CTX
*ctx
,
578 struct dptr_struct
*dptr
,
580 SMB_STRUCT_STAT
*pst
)
582 SET_STAT_INVALID(*pst
);
584 if (dptr
->has_wild
) {
585 return dptr_normal_ReadDirName(dptr
, poffset
, pst
);
588 /* If poffset is -1 then we know we returned this name before and we have
589 no wildcards. We're at the end of the directory. */
590 if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
594 if (!dptr
->did_stat
) {
595 char *pathreal
= NULL
;
597 /* We know the stored wcard contains no wildcard characters. See if we can match
598 with a stat call. If we can't, then set did_stat to true to
599 ensure we only do this once and keep searching. */
601 dptr
->did_stat
= True
;
603 /* First check if it should be visible. */
604 if (!is_visible_file(dptr
->conn
, dptr
->path
, dptr
->wcard
, pst
, True
)) {
605 /* This only returns False if the file was found, but
606 is explicitly not visible. Set us to end of directory,
607 but return NULL as we know we can't ever find it. */
608 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
612 if (VALID_STAT(*pst
)) {
613 /* We need to set the underlying dir_hnd offset to -1 also as
614 this function is usually called with the output from TellDir. */
615 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
619 pathreal
= talloc_asprintf(ctx
,
627 if (SMB_VFS_STAT(dptr
->conn
,pathreal
,pst
) == 0) {
628 /* We need to set the underlying dir_hnd offset to -1 also as
629 this function is usually called with the output from TellDir. */
630 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
631 TALLOC_FREE(pathreal
);
634 /* If we get any other error than ENOENT or ENOTDIR
635 then the file exists we just can't stat it. */
636 if (errno
!= ENOENT
&& errno
!= ENOTDIR
) {
637 /* We need to set the underlying dir_hdn offset to -1 also as
638 this function is usually called with the output from TellDir. */
639 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
640 TALLOC_FREE(pathreal
);
645 TALLOC_FREE(pathreal
);
647 /* Stat failed. We know this is authoratiative if we are
648 * providing case sensitive semantics or the underlying
649 * filesystem is case sensitive.
652 if (dptr
->conn
->case_sensitive
||
653 !(dptr
->conn
->fs_capabilities
& FILE_CASE_SENSITIVE_SEARCH
)) {
654 /* We need to set the underlying dir_hnd offset to -1 also as
655 this function is usually called with the output from TellDir. */
656 dptr
->dir_hnd
->offset
= *poffset
= END_OF_DIRECTORY_OFFSET
;
660 return dptr_normal_ReadDirName(dptr
, poffset
, pst
);
663 /****************************************************************************
664 Search for a file by name, skipping veto'ed and not visible files.
665 ****************************************************************************/
667 bool dptr_SearchDir(struct dptr_struct
*dptr
, const char *name
, long *poffset
, SMB_STRUCT_STAT
*pst
)
669 SET_STAT_INVALID(*pst
);
671 if (!dptr
->has_wild
&& (dptr
->dir_hnd
->offset
== END_OF_DIRECTORY_OFFSET
)) {
672 /* This is a singleton directory and we're already at the end. */
673 *poffset
= END_OF_DIRECTORY_OFFSET
;
677 return SearchDir(dptr
->dir_hnd
, name
, poffset
);
680 /****************************************************************************
681 Add the name we're returning into the underlying cache.
682 ****************************************************************************/
684 void dptr_DirCacheAdd(struct dptr_struct
*dptr
, const char *name
, long offset
)
686 DirCacheAdd(dptr
->dir_hnd
, name
, offset
);
689 /****************************************************************************
690 Fill the 5 byte server reserved dptr field.
691 ****************************************************************************/
693 bool dptr_fill(char *buf1
,unsigned int key
)
695 unsigned char *buf
= (unsigned char *)buf1
;
696 struct dptr_struct
*dptr
= dptr_get(key
, False
);
699 DEBUG(1,("filling null dirptr %d\n",key
));
702 offset
= (uint32
)TellDir(dptr
->dir_hnd
);
703 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key
,
704 (long)dptr
->dir_hnd
,(int)offset
));
710 /****************************************************************************
711 Fetch the dir ptr and seek it given the 5 byte server field.
712 ****************************************************************************/
714 struct dptr_struct
*dptr_fetch(char *buf
,int *num
)
716 unsigned int key
= *(unsigned char *)buf
;
717 struct dptr_struct
*dptr
= dptr_get(key
, False
);
722 DEBUG(3,("fetched null dirptr %d\n",key
));
726 offset
= IVAL(buf
,1);
727 if (offset
== (uint32
)-1) {
728 seekoff
= END_OF_DIRECTORY_OFFSET
;
730 seekoff
= (long)offset
;
732 SeekDir(dptr
->dir_hnd
,seekoff
);
733 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
734 key
,dptr_path(key
),(int)seekoff
));
738 /****************************************************************************
740 ****************************************************************************/
742 struct dptr_struct
*dptr_fetch_lanman2(int dptr_num
)
744 struct dptr_struct
*dptr
= dptr_get(dptr_num
, False
);
747 DEBUG(3,("fetched null dirptr %d\n",dptr_num
));
750 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num
,dptr_path(dptr_num
)));
754 /****************************************************************************
755 Check that a file matches a particular file type.
756 ****************************************************************************/
758 bool dir_check_ftype(connection_struct
*conn
, uint32 mode
, uint32 dirtype
)
762 /* Check the "may have" search bits. */
763 if (((mode
& ~dirtype
) & (aHIDDEN
| aSYSTEM
| aDIR
)) != 0)
766 /* Check the "must have" bits, which are the may have bits shifted eight */
767 /* If must have bit is set, the file/dir can not be returned in search unless the matching
768 file attribute is set */
769 mask
= ((dirtype
>> 8) & (aDIR
|aARCH
|aRONLY
|aHIDDEN
|aSYSTEM
)); /* & 0x37 */
771 if((mask
& (mode
& (aDIR
|aARCH
|aRONLY
|aHIDDEN
|aSYSTEM
))) == mask
) /* check if matching attribute present */
780 static bool mangle_mask_match(connection_struct
*conn
,
781 const char *filename
,
786 if (!name_to_8_3(filename
,mname
,False
,conn
->params
)) {
789 return mask_match_search(mname
,mask
,False
);
792 /****************************************************************************
793 Get an 8.3 directory entry.
794 ****************************************************************************/
796 bool get_dir_entry(TALLOC_CTX
*ctx
,
797 connection_struct
*conn
,
807 const char *dname
= NULL
;
809 SMB_STRUCT_STAT sbuf
;
810 char *pathreal
= NULL
;
811 const char *filename
= NULL
;
814 *pp_fname_out
= NULL
;
816 needslash
= ( conn
->dirpath
[strlen(conn
->dirpath
) -1] != '/');
823 long curoff
= dptr_TellDir(conn
->dirptr
);
824 dname
= dptr_ReadDirName(ctx
, conn
->dirptr
, &curoff
, &sbuf
);
826 DEBUG(6,("readdir on dirptr 0x%lx now at offset %ld\n",
827 (long)conn
->dirptr
,TellDir(conn
->dirptr
->dir_hnd
)));
835 /* notice the special *.* handling. This appears to be the only difference
836 between the wildcard handling in this routine and in the trans2 routines.
837 see masktest for a demo
839 if ((strcmp(mask
,"*.*") == 0) ||
840 mask_match_search(filename
,mask
,False
) ||
841 mangle_mask_match(conn
,filename
,mask
)) {
844 if (!mangle_is_8_3(filename
, False
, conn
->params
)) {
845 if (!name_to_8_3(filename
,mname
,False
,
853 pathreal
= talloc_asprintf(ctx
,
858 pathreal
= talloc_asprintf(ctx
,
867 if (!VALID_STAT(sbuf
) && (SMB_VFS_STAT(conn
, pathreal
, &sbuf
)) != 0) {
868 DEBUG(5,("Couldn't stat 1 [%s]. Error = %s\n",
869 pathreal
, strerror(errno
) ));
870 TALLOC_FREE(pathreal
);
874 *mode
= dos_mode(conn
,pathreal
,&sbuf
);
876 if (!dir_check_ftype(conn
,*mode
,dirtype
)) {
877 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",filename
,(unsigned int)*mode
,(unsigned int)dirtype
));
878 TALLOC_FREE(pathreal
);
882 *size
= sbuf
.st_size
;
883 *date
= sbuf
.st_mtime
;
886 struct timespec write_time_ts
;
887 struct file_id fileid
;
889 fileid
= vfs_file_id_from_sbuf(conn
, &sbuf
);
890 get_file_infos(fileid
, NULL
, &write_time_ts
);
891 if (!null_timespec(write_time_ts
)) {
892 *date
= convert_timespec_to_time_t(write_time_ts
);
896 DEBUG(3,("get_dir_entry mask=[%s] found %s "
905 *pp_fname_out
= talloc_strdup(ctx
, filename
);
906 if (!*pp_fname_out
) {
910 DirCacheAdd(conn
->dirptr
->dir_hnd
, dname
, curoff
);
911 TALLOC_FREE(pathreal
);
918 /*******************************************************************
919 Check to see if a user can read a file. This is only approximate,
920 it is used as part of the "hide unreadable" option. Don't
921 use it for anything security sensitive.
922 ********************************************************************/
924 static bool user_can_read_file(connection_struct
*conn
, char *name
)
927 * If user is a member of the Admin group
928 * we never hide files from them.
931 if (conn
->admin_user
) {
935 return can_access_file_acl(conn
, name
, FILE_READ_DATA
);
938 /*******************************************************************
939 Check to see if a user can write a file (and only files, we do not
940 check dirs on this one). This is only approximate,
941 it is used as part of the "hide unwriteable" option. Don't
942 use it for anything security sensitive.
943 ********************************************************************/
945 static bool user_can_write_file(connection_struct
*conn
, char *name
, SMB_STRUCT_STAT
*pst
)
948 * If user is a member of the Admin group
949 * we never hide files from them.
952 if (conn
->admin_user
) {
956 SMB_ASSERT(VALID_STAT(*pst
));
958 /* Pseudo-open the file */
960 if(S_ISDIR(pst
->st_mode
)) {
964 return can_write_to_file(conn
, name
, pst
);
967 /*******************************************************************
968 Is a file a "special" type ?
969 ********************************************************************/
971 static bool file_is_special(connection_struct
*conn
, char *name
, SMB_STRUCT_STAT
*pst
)
974 * If user is a member of the Admin group
975 * we never hide files from them.
978 if (conn
->admin_user
)
981 SMB_ASSERT(VALID_STAT(*pst
));
983 if (S_ISREG(pst
->st_mode
) || S_ISDIR(pst
->st_mode
) || S_ISLNK(pst
->st_mode
))
989 /*******************************************************************
990 Should the file be seen by the client ? NOTE: A successful return
991 is no guarantee of the file's existence ... you also have to check
992 whether pst is valid.
993 ********************************************************************/
995 bool is_visible_file(connection_struct
*conn
, const char *dir_path
, const char *name
, SMB_STRUCT_STAT
*pst
, bool use_veto
)
997 bool hide_unreadable
= lp_hideunreadable(SNUM(conn
));
998 bool hide_unwriteable
= lp_hideunwriteable_files(SNUM(conn
));
999 bool hide_special
= lp_hide_special_files(SNUM(conn
));
1001 SET_STAT_INVALID(*pst
);
1003 if ((strcmp(".",name
) == 0) || (strcmp("..",name
) == 0)) {
1004 return True
; /* . and .. are always visible. */
1007 /* If it's a vetoed file, pretend it doesn't even exist */
1008 if (use_veto
&& IS_VETO_PATH(conn
, name
)) {
1009 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name
));
1013 if (hide_unreadable
|| hide_unwriteable
|| hide_special
) {
1016 if (asprintf(&entry
, "%s/%s", dir_path
, name
) == -1) {
1020 /* If it's a dfs symlink, ignore _hide xxxx_ options */
1021 if (lp_host_msdfs() &&
1022 lp_msdfs_root(SNUM(conn
)) &&
1023 is_msdfs_link(conn
, entry
, NULL
)) {
1028 /* If the file name does not exist, there's no point checking
1029 * the configuration options. We succeed, on the basis that the
1030 * checks *might* have passed if the file was present.
1032 if (SMB_VFS_STAT(conn
, entry
, pst
) != 0) {
1037 /* Honour _hide unreadable_ option */
1038 if (hide_unreadable
&& !user_can_read_file(conn
, entry
)) {
1039 DEBUG(10,("is_visible_file: file %s is unreadable.\n", entry
));
1043 /* Honour _hide unwriteable_ option */
1044 if (hide_unwriteable
&& !user_can_write_file(conn
, entry
, pst
)) {
1045 DEBUG(10,("is_visible_file: file %s is unwritable.\n", entry
));
1049 /* Honour _hide_special_ option */
1050 if (hide_special
&& file_is_special(conn
, entry
, pst
)) {
1051 DEBUG(10,("is_visible_file: file %s is special.\n", entry
));
1060 static int smb_Dir_destructor(struct smb_Dir
*dirp
)
1063 SMB_VFS_CLOSEDIR(dirp
->conn
,dirp
->dir
);
1069 /*******************************************************************
1071 ********************************************************************/
1073 struct smb_Dir
*OpenDir(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
,
1074 const char *name
, const char *mask
, uint32 attr
)
1076 struct smb_Dir
*dirp
= TALLOC_ZERO_P(mem_ctx
, struct smb_Dir
);
1083 dirp
->name_cache_size
= lp_directory_name_cache_size(SNUM(conn
));
1085 dirp
->dir_path
= talloc_strdup(dirp
, name
);
1086 if (!dirp
->dir_path
) {
1092 talloc_set_destructor(dirp
, smb_Dir_destructor
);
1094 dirp
->dir
= SMB_VFS_OPENDIR(conn
, dirp
->dir_path
, mask
, attr
);
1096 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp
->dir_path
,
1108 /*******************************************************************
1109 Read from a directory. Also return current offset.
1110 Don't check for veto or invisible files.
1111 ********************************************************************/
1113 const char *ReadDirName(struct smb_Dir
*dirp
, long *poffset
)
1116 connection_struct
*conn
= dirp
->conn
;
1118 /* Cheat to allow . and .. to be the first entries returned. */
1119 if (((*poffset
== START_OF_DIRECTORY_OFFSET
) || (*poffset
== DOT_DOT_DIRECTORY_OFFSET
)) && (dirp
->file_number
< 2)) {
1120 if (dirp
->file_number
== 0) {
1122 *poffset
= dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1124 *poffset
= dirp
->offset
= DOT_DOT_DIRECTORY_OFFSET
;
1127 dirp
->file_number
++;
1129 } else if (*poffset
== END_OF_DIRECTORY_OFFSET
) {
1130 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1133 /* A real offset, seek to it. */
1134 SeekDir(dirp
, *poffset
);
1137 while ((n
= vfs_readdirname(conn
, dirp
->dir
))) {
1138 /* Ignore . and .. - we've already returned them. */
1140 if ((n
[1] == '\0') || (n
[1] == '.' && n
[2] == '\0')) {
1144 *poffset
= dirp
->offset
= SMB_VFS_TELLDIR(conn
, dirp
->dir
);
1145 dirp
->file_number
++;
1148 *poffset
= dirp
->offset
= END_OF_DIRECTORY_OFFSET
;
1152 /*******************************************************************
1153 Rewind to the start.
1154 ********************************************************************/
1156 void RewindDir(struct smb_Dir
*dirp
, long *poffset
)
1158 SMB_VFS_REWINDDIR(dirp
->conn
, dirp
->dir
);
1159 dirp
->file_number
= 0;
1160 dirp
->offset
= START_OF_DIRECTORY_OFFSET
;
1161 *poffset
= START_OF_DIRECTORY_OFFSET
;
1164 /*******************************************************************
1166 ********************************************************************/
1168 void SeekDir(struct smb_Dir
*dirp
, long offset
)
1170 if (offset
!= dirp
->offset
) {
1171 if (offset
== START_OF_DIRECTORY_OFFSET
) {
1172 RewindDir(dirp
, &offset
);
1174 * Ok we should really set the file number here
1175 * to 1 to enable ".." to be returned next. Trouble
1176 * is I'm worried about callers using SeekDir(dirp,0)
1177 * as equivalent to RewindDir(). So leave this alone
1180 } else if (offset
== DOT_DOT_DIRECTORY_OFFSET
) {
1181 RewindDir(dirp
, &offset
);
1183 * Set the file number to 2 - we want to get the first
1184 * real file entry (the one we return after "..")
1185 * on the next ReadDir.
1187 dirp
->file_number
= 2;
1188 } else if (offset
== END_OF_DIRECTORY_OFFSET
) {
1189 ; /* Don't seek in this case. */
1191 SMB_VFS_SEEKDIR(dirp
->conn
, dirp
->dir
, offset
);
1193 dirp
->offset
= offset
;
1197 /*******************************************************************
1198 Tell a dir position.
1199 ********************************************************************/
1201 long TellDir(struct smb_Dir
*dirp
)
1203 return(dirp
->offset
);
1206 /*******************************************************************
1207 Add an entry into the dcache.
1208 ********************************************************************/
1210 void DirCacheAdd(struct smb_Dir
*dirp
, const char *name
, long offset
)
1212 struct name_cache_entry
*e
;
1214 if (dirp
->name_cache_size
== 0) {
1218 if (dirp
->name_cache
== NULL
) {
1219 dirp
->name_cache
= TALLOC_ZERO_ARRAY(
1220 dirp
, struct name_cache_entry
, dirp
->name_cache_size
);
1222 if (dirp
->name_cache
== NULL
) {
1227 dirp
->name_cache_index
= (dirp
->name_cache_index
+1) %
1228 dirp
->name_cache_size
;
1229 e
= &dirp
->name_cache
[dirp
->name_cache_index
];
1230 TALLOC_FREE(e
->name
);
1231 e
->name
= talloc_strdup(dirp
, name
);
1235 /*******************************************************************
1236 Find an entry by name. Leave us at the offset after it.
1237 Don't check for veto or invisible files.
1238 ********************************************************************/
1240 bool SearchDir(struct smb_Dir
*dirp
, const char *name
, long *poffset
)
1244 connection_struct
*conn
= dirp
->conn
;
1246 /* Search back in the name cache. */
1247 if (dirp
->name_cache_size
&& dirp
->name_cache
) {
1248 for (i
= dirp
->name_cache_index
; i
>= 0; i
--) {
1249 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1250 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1251 *poffset
= e
->offset
;
1252 SeekDir(dirp
, e
->offset
);
1256 for (i
= dirp
->name_cache_size
- 1; i
> dirp
->name_cache_index
; i
--) {
1257 struct name_cache_entry
*e
= &dirp
->name_cache
[i
];
1258 if (e
->name
&& (conn
->case_sensitive
? (strcmp(e
->name
, name
) == 0) : strequal(e
->name
, name
))) {
1259 *poffset
= e
->offset
;
1260 SeekDir(dirp
, e
->offset
);
1266 /* Not found in the name cache. Rewind directory and start from scratch. */
1267 SMB_VFS_REWINDDIR(conn
, dirp
->dir
);
1268 dirp
->file_number
= 0;
1269 *poffset
= START_OF_DIRECTORY_OFFSET
;
1270 while ((entry
= ReadDirName(dirp
, poffset
))) {
1271 if (conn
->case_sensitive
? (strcmp(entry
, name
) == 0) : strequal(entry
, name
)) {
1278 /*****************************************************************
1279 Is this directory empty ?
1280 *****************************************************************/
1282 NTSTATUS
can_delete_directory(struct connection_struct
*conn
,
1283 const char *dirname
)
1285 NTSTATUS status
= NT_STATUS_OK
;
1288 struct smb_Dir
*dir_hnd
= OpenDir(talloc_tos(), conn
, dirname
,
1292 return map_nt_error_from_unix(errno
);
1295 while ((dname
= ReadDirName(dir_hnd
,&dirpos
))) {
1298 /* Quick check for "." and ".." */
1299 if (dname
[0] == '.') {
1300 if (!dname
[1] || (dname
[1] == '.' && !dname
[2])) {
1305 if (!is_visible_file(conn
, dirname
, dname
, &st
, True
)) {
1309 DEBUG(10,("can_delete_directory: got name %s - can't delete\n", dname
));
1310 status
= NT_STATUS_DIRECTORY_NOT_EMPTY
;
1313 TALLOC_FREE(dir_hnd
);