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/>.
22 #include "smbd/globals.h"
23 #include "libcli/security/security.h"
26 This module implements directory related functions for Samba.
29 /* "Special" directory offsets. */
30 #define END_OF_DIRECTORY_OFFSET ((long)-1)
31 #define START_OF_DIRECTORY_OFFSET ((long)0)
32 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
34 /* Make directory handle internals available. */
36 struct name_cache_entry {
42 connection_struct *conn;
46 size_t name_cache_size;
47 struct name_cache_entry *name_cache;
48 unsigned int name_cache_index;
49 unsigned int file_number;
53 struct dptr_struct *next, *prev;
56 struct connection_struct *conn;
57 struct smb_Dir *dir_hnd;
62 bool has_wild; /* Set to true if the wcard entry has MS wildcard characters in it. */
63 bool did_stat; /* Optimisation for non-wcard searches. */
66 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
71 #define INVALID_DPTR_KEY (-3)
73 /****************************************************************************
75 ****************************************************************************/
77 bool make_dir_struct(TALLOC_CTX *ctx,
87 char *mask2 = talloc_strdup(ctx, mask);
93 if ((mode & aDIR) != 0) {
98 if ((p = strchr_m(mask2,'.')) != NULL) {
100 push_ascii(buf+1,mask2,8, 0);
101 push_ascii(buf+9,p+1,3, 0);
104 push_ascii(buf+1,mask2,11, 0);
107 memset(buf+21,'\0',DIR_STRUCT_SIZE-21);
109 srv_put_dos_date(buf,22,date);
110 SSVAL(buf,26,size & 0xFFFF);
111 SSVAL(buf,28,(size >> 16)&0xFFFF);
112 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
113 Strange, but verified on W2K3. Needed for OS/2. JRA. */
114 push_ascii(buf+30,fname,12, uc ? STR_UPPER : 0);
115 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf+30, fname));
119 /****************************************************************************
120 Initialise the dir bitmap.
121 ****************************************************************************/
123 bool init_dptrs(struct smbd_server_connection *sconn)
125 if (sconn->searches.dptr_bmap) {
129 sconn->searches.dptr_bmap = bitmap_talloc(
130 sconn, MAX_DIRECTORY_HANDLES);
132 if (sconn->searches.dptr_bmap == NULL) {
139 /****************************************************************************
140 Idle a dptr - the directory is closed but the control info is kept.
141 ****************************************************************************/
143 static void dptr_idle(struct dptr_struct *dptr)
146 DEBUG(4,("Idling dptr dnum %d\n",dptr->dnum));
147 TALLOC_FREE(dptr->dir_hnd);
151 /****************************************************************************
152 Idle the oldest dptr.
153 ****************************************************************************/
155 static void dptr_idleoldest(struct smbd_server_connection *sconn)
157 struct dptr_struct *dptr;
160 * Go to the end of the list.
162 dptr = DLIST_TAIL(sconn->searches.dirptrs);
165 DEBUG(0,("No dptrs available to idle ?\n"));
170 * Idle the oldest pointer.
173 for(; dptr; dptr = DLIST_PREV(dptr)) {
181 /****************************************************************************
182 Get the struct dptr_struct for a dir index.
183 ****************************************************************************/
185 static struct dptr_struct *dptr_get(struct smbd_server_connection *sconn,
186 int key, bool forclose)
188 struct dptr_struct *dptr;
190 for(dptr = sconn->searches.dirptrs; dptr; dptr = dptr->next) {
191 if(dptr->dnum == key) {
192 if (!forclose && !dptr->dir_hnd) {
193 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES)
194 dptr_idleoldest(sconn);
195 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key));
196 if (!(dptr->dir_hnd = OpenDir(
197 NULL, dptr->conn, dptr->path,
198 dptr->wcard, dptr->attr))) {
199 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr->path,
204 DLIST_PROMOTE(sconn->searches.dirptrs,dptr);
211 /****************************************************************************
212 Get the dir path for a dir index.
213 ****************************************************************************/
215 char *dptr_path(struct smbd_server_connection *sconn, int key)
217 struct dptr_struct *dptr = dptr_get(sconn, key, false);
223 /****************************************************************************
224 Get the dir wcard for a dir index.
225 ****************************************************************************/
227 char *dptr_wcard(struct smbd_server_connection *sconn, int key)
229 struct dptr_struct *dptr = dptr_get(sconn, key, false);
235 /****************************************************************************
236 Get the dir attrib for a dir index.
237 ****************************************************************************/
239 uint16 dptr_attr(struct smbd_server_connection *sconn, int key)
241 struct dptr_struct *dptr = dptr_get(sconn, key, false);
247 /****************************************************************************
248 Close a dptr (internal func).
249 ****************************************************************************/
251 static void dptr_close_internal(struct dptr_struct *dptr)
253 struct smbd_server_connection *sconn = dptr->conn->sconn;
255 DEBUG(4,("closing dptr key %d\n",dptr->dnum));
261 DLIST_REMOVE(sconn->searches.dirptrs, dptr);
264 * Free the dnum in the bitmap. Remember the dnum value is always
265 * biased by one with respect to the bitmap.
268 if (!bitmap_query(sconn->searches.dptr_bmap, dptr->dnum - 1)) {
269 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
273 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
276 TALLOC_FREE(dptr->dir_hnd);
278 /* Lanman 2 specific code */
279 SAFE_FREE(dptr->wcard);
280 string_set(&dptr->path,"");
284 /****************************************************************************
285 Close a dptr given a key.
286 ****************************************************************************/
288 void dptr_close(struct smbd_server_connection *sconn, int *key)
290 struct dptr_struct *dptr;
292 if(*key == INVALID_DPTR_KEY)
295 /* OS/2 seems to use -1 to indicate "close all directories" */
297 struct dptr_struct *next;
298 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
300 dptr_close_internal(dptr);
302 *key = INVALID_DPTR_KEY;
306 dptr = dptr_get(sconn, *key, true);
309 DEBUG(0,("Invalid key %d given to dptr_close\n", *key));
313 dptr_close_internal(dptr);
315 *key = INVALID_DPTR_KEY;
318 /****************************************************************************
319 Close all dptrs for a cnum.
320 ****************************************************************************/
322 void dptr_closecnum(connection_struct *conn)
324 struct dptr_struct *dptr, *next;
325 struct smbd_server_connection *sconn = conn->sconn;
331 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
333 if (dptr->conn == conn) {
334 dptr_close_internal(dptr);
339 /****************************************************************************
340 Idle all dptrs for a cnum.
341 ****************************************************************************/
343 void dptr_idlecnum(connection_struct *conn)
345 struct dptr_struct *dptr;
346 struct smbd_server_connection *sconn = conn->sconn;
352 for(dptr = sconn->searches.dirptrs; dptr; dptr = dptr->next) {
353 if (dptr->conn == conn && dptr->dir_hnd) {
359 /****************************************************************************
360 Close a dptr that matches a given path, only if it matches the spid also.
361 ****************************************************************************/
363 void dptr_closepath(struct smbd_server_connection *sconn,
364 char *path,uint16 spid)
366 struct dptr_struct *dptr, *next;
367 for(dptr = sconn->searches.dirptrs; dptr; dptr = next) {
369 if (spid == dptr->spid && strequal(dptr->path,path))
370 dptr_close_internal(dptr);
374 /****************************************************************************
375 Try and close the oldest handle not marked for
376 expect close in the hope that the client has
377 finished with that one.
378 ****************************************************************************/
380 static void dptr_close_oldest(struct smbd_server_connection *sconn,
383 struct dptr_struct *dptr;
386 * Go to the end of the list.
388 for(dptr = sconn->searches.dirptrs; dptr && dptr->next; dptr = dptr->next)
392 DEBUG(0,("No old dptrs available to close oldest ?\n"));
397 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
398 * does not have expect_close set. If 'old' is false, close
399 * one of the new dnum handles.
402 for(; dptr; dptr = DLIST_PREV(dptr)) {
403 if ((old && (dptr->dnum < 256) && !dptr->expect_close) ||
404 (!old && (dptr->dnum > 255))) {
405 dptr_close_internal(dptr);
411 /****************************************************************************
412 Create a new dir ptr. If the flag old_handle is true then we must allocate
413 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
414 one byte long. If old_handle is false we allocate from the range
415 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
416 a directory handle is never zero.
417 wcard must not be zero.
418 ****************************************************************************/
420 NTSTATUS dptr_create(connection_struct *conn, files_struct *fsp,
421 const char *path, bool old_handle, bool expect_close,uint16 spid,
422 const char *wcard, bool wcard_has_wild, uint32 attr, struct dptr_struct **dptr_ret)
424 struct smbd_server_connection *sconn = conn->sconn;
425 struct dptr_struct *dptr = NULL;
426 struct smb_Dir *dir_hnd;
429 if (fsp && fsp->is_directory && fsp->fh->fd != -1) {
430 path = fsp->fsp_name->base_name;
433 DEBUG(5,("dptr_create dir=%s\n", path));
436 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
437 return NT_STATUS_INTERNAL_ERROR;
441 return NT_STATUS_INVALID_PARAMETER;
445 dir_hnd = OpenDir_fsp(NULL, conn, fsp, wcard, attr);
447 status = check_name(conn,path);
448 if (!NT_STATUS_IS_OK(status)) {
451 dir_hnd = OpenDir(NULL, conn, path, wcard, attr);
455 return map_nt_error_from_unix(errno);
458 if (sconn->searches.dirhandles_open >= MAX_OPEN_DIRECTORIES) {
459 dptr_idleoldest(sconn);
462 dptr = SMB_MALLOC_P(struct dptr_struct);
464 DEBUG(0,("malloc fail in dptr_create.\n"));
465 TALLOC_FREE(dir_hnd);
466 return NT_STATUS_NO_MEMORY;
474 * This is an old-style SMBsearch request. Ensure the
475 * value we return will fit in the range 1-255.
478 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
480 if(dptr->dnum == -1 || dptr->dnum > 254) {
483 * Try and close the oldest handle not marked for
484 * expect close in the hope that the client has
485 * finished with that one.
488 dptr_close_oldest(sconn, true);
490 /* Now try again... */
491 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 0);
492 if(dptr->dnum == -1 || dptr->dnum > 254) {
493 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr->dnum));
495 TALLOC_FREE(dir_hnd);
496 return NT_STATUS_TOO_MANY_OPENED_FILES;
502 * This is a new-style trans2 request. Allocate from
503 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
506 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
508 if(dptr->dnum == -1 || dptr->dnum < 255) {
511 * Try and close the oldest handle close in the hope that
512 * the client has finished with that one. This will only
513 * happen in the case of the Win98 client bug where it leaks
517 dptr_close_oldest(sconn, false);
519 /* Now try again... */
520 dptr->dnum = bitmap_find(sconn->searches.dptr_bmap, 255);
522 if(dptr->dnum == -1 || dptr->dnum < 255) {
523 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr->dnum));
525 TALLOC_FREE(dir_hnd);
526 return NT_STATUS_TOO_MANY_OPENED_FILES;
531 bitmap_set(sconn->searches.dptr_bmap, dptr->dnum);
533 dptr->dnum += 1; /* Always bias the dnum by one - no zero dnums allowed. */
535 string_set(&dptr->path,path);
537 dptr->dir_hnd = dir_hnd;
539 dptr->expect_close = expect_close;
540 dptr->wcard = SMB_STRDUP(wcard);
542 bitmap_clear(sconn->searches.dptr_bmap, dptr->dnum - 1);
544 TALLOC_FREE(dir_hnd);
545 return NT_STATUS_NO_MEMORY;
547 if (lp_posix_pathnames() || (wcard[0] == '.' && wcard[1] == 0)) {
548 dptr->has_wild = True;
550 dptr->has_wild = wcard_has_wild;
555 DLIST_ADD(sconn->searches.dirptrs, dptr);
557 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
558 dptr->dnum,path,expect_close));
566 /****************************************************************************
567 Wrapper functions to access the lower level directory handles.
568 ****************************************************************************/
570 void dptr_CloseDir(files_struct *fsp)
574 * Ugly hack. We have defined fdopendir to return ENOSYS if dirfd also isn't
575 * present. I hate Solaris. JRA.
578 if (fsp->fh->fd != -1 &&
579 fsp->dptr->dir_hnd &&
580 dirfd(fsp->dptr->dir_hnd->dir)) {
581 /* The call below closes the underlying fd. */
585 dptr_close_internal(fsp->dptr);
590 void dptr_SeekDir(struct dptr_struct *dptr, long offset)
592 SeekDir(dptr->dir_hnd, offset);
595 long dptr_TellDir(struct dptr_struct *dptr)
597 return TellDir(dptr->dir_hnd);
600 bool dptr_has_wild(struct dptr_struct *dptr)
602 return dptr->has_wild;
605 int dptr_dnum(struct dptr_struct *dptr)
610 /****************************************************************************
611 Return the next visible file name, skipping veto'd and invisible files.
612 ****************************************************************************/
614 static const char *dptr_normal_ReadDirName(struct dptr_struct *dptr,
615 long *poffset, SMB_STRUCT_STAT *pst,
618 /* Normal search for the next file. */
620 char *talloced = NULL;
622 while ((name = ReadDirName(dptr->dir_hnd, poffset, pst, &talloced))
624 if (is_visible_file(dptr->conn, dptr->path, name, pst, True)) {
625 *ptalloced = talloced;
628 TALLOC_FREE(talloced);
633 /****************************************************************************
634 Return the next visible file name, skipping veto'd and invisible files.
635 ****************************************************************************/
637 char *dptr_ReadDirName(TALLOC_CTX *ctx,
638 struct dptr_struct *dptr,
640 SMB_STRUCT_STAT *pst)
642 struct smb_filename smb_fname_base;
644 const char *name_temp = NULL;
645 char *talloced = NULL;
646 char *pathreal = NULL;
647 char *found_name = NULL;
650 SET_STAT_INVALID(*pst);
652 if (dptr->has_wild || dptr->did_stat) {
653 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst,
655 if (name_temp == NULL) {
658 if (talloced != NULL) {
659 return talloc_move(ctx, &talloced);
661 return talloc_strdup(ctx, name_temp);
664 /* If poffset is -1 then we know we returned this name before and we
665 * have no wildcards. We're at the end of the directory. */
666 if (*poffset == END_OF_DIRECTORY_OFFSET) {
670 /* We know the stored wcard contains no wildcard characters.
671 * See if we can match with a stat call. If we can't, then set
672 * did_stat to true to ensure we only do this once and keep
675 dptr->did_stat = true;
677 /* First check if it should be visible. */
678 if (!is_visible_file(dptr->conn, dptr->path, dptr->wcard,
681 /* This only returns false if the file was found, but
682 is explicitly not visible. Set us to end of
683 directory, but return NULL as we know we can't ever
688 if (VALID_STAT(*pst)) {
689 name = talloc_strdup(ctx, dptr->wcard);
693 pathreal = talloc_asprintf(ctx,
700 /* Create an smb_filename with stream_name == NULL. */
701 ZERO_STRUCT(smb_fname_base);
702 smb_fname_base.base_name = pathreal;
704 if (SMB_VFS_STAT(dptr->conn, &smb_fname_base) == 0) {
705 *pst = smb_fname_base.st;
706 name = talloc_strdup(ctx, dptr->wcard);
709 /* If we get any other error than ENOENT or ENOTDIR
710 then the file exists we just can't stat it. */
711 if (errno != ENOENT && errno != ENOTDIR) {
712 name = talloc_strdup(ctx, dptr->wcard);
717 /* Stat failed. We know this is authoratiative if we are
718 * providing case sensitive semantics or the underlying
719 * filesystem is case sensitive.
721 if (dptr->conn->case_sensitive ||
722 !(dptr->conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH))
728 * Try case-insensitive stat if the fs has the ability. This avoids
729 * scanning the whole directory.
731 ret = SMB_VFS_GET_REAL_FILENAME(dptr->conn, dptr->path, dptr->wcard,
736 } else if (errno == ENOENT) {
737 /* The case-insensitive lookup was authoritative. */
741 TALLOC_FREE(pathreal);
743 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst, &talloced);
744 if (name_temp == NULL) {
747 if (talloced != NULL) {
748 return talloc_move(ctx, &talloced);
750 return talloc_strdup(ctx, name_temp);
753 TALLOC_FREE(pathreal);
755 /* We need to set the underlying dir_hnd offset to -1
756 * also as this function is usually called with the
757 * output from TellDir. */
758 dptr->dir_hnd->offset = *poffset = END_OF_DIRECTORY_OFFSET;
762 /****************************************************************************
763 Search for a file by name, skipping veto'ed and not visible files.
764 ****************************************************************************/
766 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst)
768 SET_STAT_INVALID(*pst);
770 if (!dptr->has_wild && (dptr->dir_hnd->offset == END_OF_DIRECTORY_OFFSET)) {
771 /* This is a singleton directory and we're already at the end. */
772 *poffset = END_OF_DIRECTORY_OFFSET;
776 return SearchDir(dptr->dir_hnd, name, poffset);
779 /****************************************************************************
780 Add the name we're returning into the underlying cache.
781 ****************************************************************************/
783 void dptr_DirCacheAdd(struct dptr_struct *dptr, const char *name, long offset)
785 DirCacheAdd(dptr->dir_hnd, name, offset);
788 /****************************************************************************
789 Initialize variables & state data at the beginning of all search SMB requests.
790 ****************************************************************************/
791 void dptr_init_search_op(struct dptr_struct *dptr)
793 SMB_VFS_INIT_SEARCH_OP(dptr->conn, dptr->dir_hnd->dir);
796 /****************************************************************************
797 Fill the 5 byte server reserved dptr field.
798 ****************************************************************************/
800 bool dptr_fill(struct smbd_server_connection *sconn,
801 char *buf1,unsigned int key)
803 unsigned char *buf = (unsigned char *)buf1;
804 struct dptr_struct *dptr = dptr_get(sconn, key, false);
807 DEBUG(1,("filling null dirptr %d\n",key));
810 offset = (uint32)TellDir(dptr->dir_hnd);
811 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key,
812 (long)dptr->dir_hnd,(int)offset));
818 /****************************************************************************
819 Fetch the dir ptr and seek it given the 5 byte server field.
820 ****************************************************************************/
822 struct dptr_struct *dptr_fetch(struct smbd_server_connection *sconn,
825 unsigned int key = *(unsigned char *)buf;
826 struct dptr_struct *dptr = dptr_get(sconn, key, false);
831 DEBUG(3,("fetched null dirptr %d\n",key));
835 offset = IVAL(buf,1);
836 if (offset == (uint32)-1) {
837 seekoff = END_OF_DIRECTORY_OFFSET;
839 seekoff = (long)offset;
841 SeekDir(dptr->dir_hnd,seekoff);
842 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
843 key, dptr->path, (int)seekoff));
847 /****************************************************************************
849 ****************************************************************************/
851 struct dptr_struct *dptr_fetch_lanman2(struct smbd_server_connection *sconn,
854 struct dptr_struct *dptr = dptr_get(sconn, dptr_num, false);
857 DEBUG(3,("fetched null dirptr %d\n",dptr_num));
860 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num,dptr->path));
864 /****************************************************************************
865 Check that a file matches a particular file type.
866 ****************************************************************************/
868 bool dir_check_ftype(connection_struct *conn, uint32 mode, uint32 dirtype)
872 /* Check the "may have" search bits. */
873 if (((mode & ~dirtype) & (aHIDDEN | aSYSTEM | aDIR)) != 0)
876 /* Check the "must have" bits, which are the may have bits shifted eight */
877 /* If must have bit is set, the file/dir can not be returned in search unless the matching
878 file attribute is set */
879 mask = ((dirtype >> 8) & (aDIR|aARCH|aRONLY|aHIDDEN|aSYSTEM)); /* & 0x37 */
881 if((mask & (mode & (aDIR|aARCH|aRONLY|aHIDDEN|aSYSTEM))) == mask) /* check if matching attribute present */
890 static bool mangle_mask_match(connection_struct *conn,
891 const char *filename,
896 if (!name_to_8_3(filename,mname,False,conn->params)) {
899 return mask_match_search(mname,mask,False);
902 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
903 struct dptr_struct *dirptr,
908 bool (*match_fn)(TALLOC_CTX *ctx,
913 bool (*mode_fn)(TALLOC_CTX *ctx,
915 struct smb_filename *smb_fname,
919 struct smb_filename **_smb_fname,
923 connection_struct *conn = dirptr->conn;
929 needslash = ( dirptr->path[strlen(dirptr->path) -1] != '/');
934 SMB_STRUCT_STAT sbuf;
938 char *pathreal = NULL;
939 struct smb_filename smb_fname;
944 cur_offset = dptr_TellDir(dirptr);
945 prev_offset = cur_offset;
946 dname = dptr_ReadDirName(ctx, dirptr, &cur_offset, &sbuf);
948 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
949 (long)dirptr, cur_offset));
955 isdots = (ISDOT(dname) || ISDOTDOT(dname));
956 if (dont_descend && !isdots) {
962 * fname may get mangled, dname is never mangled.
963 * Whenever we're accessing the filesystem we use
964 * pathreal which is composed from dname.
967 ok = match_fn(ctx, private_data, dname, mask, &fname);
973 pathreal = talloc_asprintf(ctx, "%s%s%s",
983 /* Create smb_fname with NULL stream_name. */
984 ZERO_STRUCT(smb_fname);
985 smb_fname.base_name = pathreal;
988 ok = mode_fn(ctx, private_data, &smb_fname, &mode);
992 TALLOC_FREE(pathreal);
996 if (!dir_check_ftype(conn, mode, dirtype)) {
997 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
998 fname, (unsigned int)mode, (unsigned int)dirtype));
1001 TALLOC_FREE(pathreal);
1005 if (ask_sharemode) {
1006 struct timespec write_time_ts;
1007 struct file_id fileid;
1009 fileid = vfs_file_id_from_sbuf(conn,
1011 get_file_infos(fileid, 0, NULL, &write_time_ts);
1012 if (!null_timespec(write_time_ts)) {
1013 update_stat_ex_mtime(&smb_fname.st,
1018 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
1020 mask, smb_fname_str_dbg(&smb_fname),
1023 DirCacheAdd(dirptr->dir_hnd, dname, cur_offset);
1027 status = copy_smb_filename(ctx, &smb_fname, _smb_fname);
1028 TALLOC_FREE(pathreal);
1029 if (!NT_STATUS_IS_OK(status)) {
1034 *_prev_offset = prev_offset;
1042 /****************************************************************************
1043 Get an 8.3 directory entry.
1044 ****************************************************************************/
1046 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX *ctx,
1052 connection_struct *conn = (connection_struct *)private_data;
1054 if ((strcmp(mask,"*.*") == 0) ||
1055 mask_match_search(dname, mask, false) ||
1056 mangle_mask_match(conn, dname, mask)) {
1060 if (!mangle_is_8_3(dname, false, conn->params)) {
1061 bool ok = name_to_8_3(dname, mname, false,
1071 *_fname = talloc_strdup(ctx, fname);
1072 if (*_fname == NULL) {
1082 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX *ctx,
1084 struct smb_filename *smb_fname,
1087 connection_struct *conn = (connection_struct *)private_data;
1089 if (!VALID_STAT(smb_fname->st)) {
1090 if ((SMB_VFS_STAT(conn, smb_fname)) != 0) {
1091 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1092 "Couldn't stat [%s]. Error "
1094 smb_fname_str_dbg(smb_fname),
1100 *_mode = dos_mode(conn, smb_fname);
1104 bool get_dir_entry(TALLOC_CTX *ctx,
1105 struct dptr_struct *dirptr,
1111 struct timespec *_date,
1115 connection_struct *conn = dirptr->conn;
1117 struct smb_filename *smb_fname = NULL;
1122 ok = smbd_dirptr_get_entry(ctx,
1128 smbd_dirptr_8_3_match_fn,
1129 smbd_dirptr_8_3_mode_fn,
1139 *_fname = talloc_move(ctx, &fname);
1140 *_size = smb_fname->st.st_ex_size;
1142 *_date = smb_fname->st.st_ex_mtime;
1143 TALLOC_FREE(smb_fname);
1147 /*******************************************************************
1148 Check to see if a user can read a file. This is only approximate,
1149 it is used as part of the "hide unreadable" option. Don't
1150 use it for anything security sensitive.
1151 ********************************************************************/
1153 static bool user_can_read_file(connection_struct *conn,
1154 struct smb_filename *smb_fname)
1157 * Never hide files from the root user.
1158 * We use (uid_t)0 here not sec_initial_uid()
1159 * as make test uses a single user context.
1162 if (get_current_uid(conn) == (uid_t)0) {
1166 return can_access_file_acl(conn, smb_fname, FILE_READ_DATA);
1169 /*******************************************************************
1170 Check to see if a user can write a file (and only files, we do not
1171 check dirs on this one). This is only approximate,
1172 it is used as part of the "hide unwriteable" option. Don't
1173 use it for anything security sensitive.
1174 ********************************************************************/
1176 static bool user_can_write_file(connection_struct *conn,
1177 const struct smb_filename *smb_fname)
1180 * Never hide files from the root user.
1181 * We use (uid_t)0 here not sec_initial_uid()
1182 * as make test uses a single user context.
1185 if (get_current_uid(conn) == (uid_t)0) {
1189 SMB_ASSERT(VALID_STAT(smb_fname->st));
1191 /* Pseudo-open the file */
1193 if(S_ISDIR(smb_fname->st.st_ex_mode)) {
1197 return can_write_to_file(conn, smb_fname);
1200 /*******************************************************************
1201 Is a file a "special" type ?
1202 ********************************************************************/
1204 static bool file_is_special(connection_struct *conn,
1205 const struct smb_filename *smb_fname)
1208 * Never hide files from the root user.
1209 * We use (uid_t)0 here not sec_initial_uid()
1210 * as make test uses a single user context.
1213 if (get_current_uid(conn) == (uid_t)0) {
1217 SMB_ASSERT(VALID_STAT(smb_fname->st));
1219 if (S_ISREG(smb_fname->st.st_ex_mode) ||
1220 S_ISDIR(smb_fname->st.st_ex_mode) ||
1221 S_ISLNK(smb_fname->st.st_ex_mode))
1227 /*******************************************************************
1228 Should the file be seen by the client?
1229 NOTE: A successful return is no guarantee of the file's existence.
1230 ********************************************************************/
1232 bool is_visible_file(connection_struct *conn, const char *dir_path,
1233 const char *name, SMB_STRUCT_STAT *pst, bool use_veto)
1235 bool hide_unreadable = lp_hideunreadable(SNUM(conn));
1236 bool hide_unwriteable = lp_hideunwriteable_files(SNUM(conn));
1237 bool hide_special = lp_hide_special_files(SNUM(conn));
1239 struct smb_filename *smb_fname_base = NULL;
1243 if ((strcmp(".",name) == 0) || (strcmp("..",name) == 0)) {
1244 return True; /* . and .. are always visible. */
1247 /* If it's a vetoed file, pretend it doesn't even exist */
1248 if (use_veto && IS_VETO_PATH(conn, name)) {
1249 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name ));
1253 if (hide_unreadable || hide_unwriteable || hide_special) {
1254 entry = talloc_asprintf(talloc_tos(), "%s/%s", dir_path, name);
1260 /* Create an smb_filename with stream_name == NULL. */
1261 status = create_synthetic_smb_fname(talloc_tos(), entry, NULL,
1262 pst, &smb_fname_base);
1263 if (!NT_STATUS_IS_OK(status)) {
1268 /* If the file name does not exist, there's no point checking
1269 * the configuration options. We succeed, on the basis that the
1270 * checks *might* have passed if the file was present.
1272 if (!VALID_STAT(*pst)) {
1273 if (SMB_VFS_STAT(conn, smb_fname_base) != 0) {
1277 *pst = smb_fname_base->st;
1281 /* Honour _hide unreadable_ option */
1282 if (hide_unreadable &&
1283 !user_can_read_file(conn, smb_fname_base)) {
1284 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1289 /* Honour _hide unwriteable_ option */
1290 if (hide_unwriteable && !user_can_write_file(conn,
1292 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1297 /* Honour _hide_special_ option */
1298 if (hide_special && file_is_special(conn, smb_fname_base)) {
1299 DEBUG(10,("is_visible_file: file %s is special.\n",
1308 TALLOC_FREE(smb_fname_base);
1313 static int smb_Dir_destructor(struct smb_Dir *dirp)
1317 if (dirp->conn->sconn) {
1318 files_struct *fsp = file_find_fd(dirp->conn->sconn,
1321 /* The call below closes the underlying fd. */
1326 SMB_VFS_CLOSEDIR(dirp->conn,dirp->dir);
1328 if (dirp->conn->sconn) {
1329 dirp->conn->sconn->searches.dirhandles_open--;
1334 /*******************************************************************
1336 ********************************************************************/
1338 struct smb_Dir *OpenDir(TALLOC_CTX *mem_ctx, connection_struct *conn,
1343 struct smb_Dir *dirp = TALLOC_ZERO_P(mem_ctx, struct smb_Dir);
1344 struct smbd_server_connection *sconn = conn->sconn;
1351 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1353 dirp->dir_path = talloc_strdup(dirp, name);
1354 if (!dirp->dir_path) {
1360 sconn->searches.dirhandles_open++;
1362 talloc_set_destructor(dirp, smb_Dir_destructor);
1364 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1366 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp->dir_path,
1378 /*******************************************************************
1379 Open a directory from an fsp.
1380 ********************************************************************/
1382 static struct smb_Dir *OpenDir_fsp(TALLOC_CTX *mem_ctx, connection_struct *conn,
1387 struct smb_Dir *dirp = TALLOC_ZERO_P(mem_ctx, struct smb_Dir);
1388 struct smbd_server_connection *sconn = conn->sconn;
1395 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1397 dirp->dir_path = talloc_strdup(dirp, fsp->fsp_name->base_name);
1398 if (!dirp->dir_path) {
1404 sconn->searches.dirhandles_open++;
1406 talloc_set_destructor(dirp, smb_Dir_destructor);
1408 if (fsp->is_directory && fsp->fh->fd != -1) {
1409 dirp->dir = SMB_VFS_FDOPENDIR(fsp, mask, attr);
1410 if (dirp->dir == NULL) {
1411 DEBUG(10,("OpenDir_fsp: SMB_VFS_FDOPENDIR on %s returned "
1415 if (errno != ENOSYS) {
1421 if (dirp->dir == NULL) {
1422 /* FDOPENDIR didn't work. Use OPENDIR instead. */
1423 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1427 DEBUG(5,("OpenDir_fsp: Can't open %s. %s\n", dirp->dir_path,
1440 /*******************************************************************
1441 Read from a directory.
1442 Return directory entry, current offset, and optional stat information.
1443 Don't check for veto or invisible files.
1444 ********************************************************************/
1446 const char *ReadDirName(struct smb_Dir *dirp, long *poffset,
1447 SMB_STRUCT_STAT *sbuf, char **ptalloced)
1450 char *talloced = NULL;
1451 connection_struct *conn = dirp->conn;
1453 /* Cheat to allow . and .. to be the first entries returned. */
1454 if (((*poffset == START_OF_DIRECTORY_OFFSET) ||
1455 (*poffset == DOT_DOT_DIRECTORY_OFFSET)) && (dirp->file_number < 2))
1457 if (dirp->file_number == 0) {
1459 *poffset = dirp->offset = START_OF_DIRECTORY_OFFSET;
1462 *poffset = dirp->offset = DOT_DOT_DIRECTORY_OFFSET;
1464 dirp->file_number++;
1467 } else if (*poffset == END_OF_DIRECTORY_OFFSET) {
1468 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1471 /* A real offset, seek to it. */
1472 SeekDir(dirp, *poffset);
1475 while ((n = vfs_readdirname(conn, dirp->dir, sbuf, &talloced))) {
1476 /* Ignore . and .. - we've already returned them. */
1478 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
1479 TALLOC_FREE(talloced);
1483 *poffset = dirp->offset = SMB_VFS_TELLDIR(conn, dirp->dir);
1484 *ptalloced = talloced;
1485 dirp->file_number++;
1488 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1493 /*******************************************************************
1494 Rewind to the start.
1495 ********************************************************************/
1497 void RewindDir(struct smb_Dir *dirp, long *poffset)
1499 SMB_VFS_REWINDDIR(dirp->conn, dirp->dir);
1500 dirp->file_number = 0;
1501 dirp->offset = START_OF_DIRECTORY_OFFSET;
1502 *poffset = START_OF_DIRECTORY_OFFSET;
1505 /*******************************************************************
1507 ********************************************************************/
1509 void SeekDir(struct smb_Dir *dirp, long offset)
1511 if (offset != dirp->offset) {
1512 if (offset == START_OF_DIRECTORY_OFFSET) {
1513 RewindDir(dirp, &offset);
1515 * Ok we should really set the file number here
1516 * to 1 to enable ".." to be returned next. Trouble
1517 * is I'm worried about callers using SeekDir(dirp,0)
1518 * as equivalent to RewindDir(). So leave this alone
1521 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
1522 RewindDir(dirp, &offset);
1524 * Set the file number to 2 - we want to get the first
1525 * real file entry (the one we return after "..")
1526 * on the next ReadDir.
1528 dirp->file_number = 2;
1529 } else if (offset == END_OF_DIRECTORY_OFFSET) {
1530 ; /* Don't seek in this case. */
1532 SMB_VFS_SEEKDIR(dirp->conn, dirp->dir, offset);
1534 dirp->offset = offset;
1538 /*******************************************************************
1539 Tell a dir position.
1540 ********************************************************************/
1542 long TellDir(struct smb_Dir *dirp)
1544 return(dirp->offset);
1547 /*******************************************************************
1548 Add an entry into the dcache.
1549 ********************************************************************/
1551 void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset)
1553 struct name_cache_entry *e;
1555 if (dirp->name_cache_size == 0) {
1559 if (dirp->name_cache == NULL) {
1560 dirp->name_cache = TALLOC_ZERO_ARRAY(
1561 dirp, struct name_cache_entry, dirp->name_cache_size);
1563 if (dirp->name_cache == NULL) {
1568 dirp->name_cache_index = (dirp->name_cache_index+1) %
1569 dirp->name_cache_size;
1570 e = &dirp->name_cache[dirp->name_cache_index];
1571 TALLOC_FREE(e->name);
1572 e->name = talloc_strdup(dirp, name);
1576 /*******************************************************************
1577 Find an entry by name. Leave us at the offset after it.
1578 Don't check for veto or invisible files.
1579 ********************************************************************/
1581 bool SearchDir(struct smb_Dir *dirp, const char *name, long *poffset)
1584 const char *entry = NULL;
1585 char *talloced = NULL;
1586 connection_struct *conn = dirp->conn;
1588 /* Search back in the name cache. */
1589 if (dirp->name_cache_size && dirp->name_cache) {
1590 for (i = dirp->name_cache_index; i >= 0; i--) {
1591 struct name_cache_entry *e = &dirp->name_cache[i];
1592 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1593 *poffset = e->offset;
1594 SeekDir(dirp, e->offset);
1598 for (i = dirp->name_cache_size - 1; i > dirp->name_cache_index; i--) {
1599 struct name_cache_entry *e = &dirp->name_cache[i];
1600 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1601 *poffset = e->offset;
1602 SeekDir(dirp, e->offset);
1608 /* Not found in the name cache. Rewind directory and start from scratch. */
1609 SMB_VFS_REWINDDIR(conn, dirp->dir);
1610 dirp->file_number = 0;
1611 *poffset = START_OF_DIRECTORY_OFFSET;
1612 while ((entry = ReadDirName(dirp, poffset, NULL, &talloced))) {
1613 if (conn->case_sensitive ? (strcmp(entry, name) == 0) : strequal(entry, name)) {
1614 TALLOC_FREE(talloced);
1617 TALLOC_FREE(talloced);
1622 /*****************************************************************
1623 Is this directory empty ?
1624 *****************************************************************/
1626 NTSTATUS can_delete_directory(struct connection_struct *conn,
1627 const char *dirname)
1629 NTSTATUS status = NT_STATUS_OK;
1631 const char *dname = NULL;
1632 char *talloced = NULL;
1634 struct smb_Dir *dir_hnd = OpenDir(talloc_tos(), conn,
1638 return map_nt_error_from_unix(errno);
1641 while ((dname = ReadDirName(dir_hnd, &dirpos, &st, &talloced))) {
1642 /* Quick check for "." and ".." */
1643 if (dname[0] == '.') {
1644 if (!dname[1] || (dname[1] == '.' && !dname[2])) {
1645 TALLOC_FREE(talloced);
1650 if (!is_visible_file(conn, dirname, dname, &st, True)) {
1651 TALLOC_FREE(talloced);
1655 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1657 status = NT_STATUS_DIRECTORY_NOT_EMPTY;
1660 TALLOC_FREE(talloced);
1661 TALLOC_FREE(dir_hnd);