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"
25 This module implements directory related functions for Samba.
28 /* "Special" directory offsets. */
29 #define END_OF_DIRECTORY_OFFSET ((long)-1)
30 #define START_OF_DIRECTORY_OFFSET ((long)0)
31 #define DOT_DOT_DIRECTORY_OFFSET ((long)0x80000000)
33 /* Make directory handle internals available. */
35 struct name_cache_entry {
41 connection_struct *conn;
45 size_t name_cache_size;
46 struct name_cache_entry *name_cache;
47 unsigned int name_cache_index;
48 unsigned int file_number;
52 struct dptr_struct *next, *prev;
55 struct connection_struct *conn;
56 struct smb_Dir *dir_hnd;
61 bool has_wild; /* Set to true if the wcard entry has MS wildcard characters in it. */
62 bool did_stat; /* Optimisation for non-wcard searches. */
66 #define INVALID_DPTR_KEY (-3)
68 /****************************************************************************
70 ****************************************************************************/
72 bool make_dir_struct(TALLOC_CTX *ctx,
82 char *mask2 = talloc_strdup(ctx, mask);
88 if ((mode & aDIR) != 0) {
93 if ((p = strchr_m(mask2,'.')) != NULL) {
95 push_ascii(buf+1,mask2,8, 0);
96 push_ascii(buf+9,p+1,3, 0);
99 push_ascii(buf+1,mask2,11, 0);
102 memset(buf+21,'\0',DIR_STRUCT_SIZE-21);
104 srv_put_dos_date(buf,22,date);
105 SSVAL(buf,26,size & 0xFFFF);
106 SSVAL(buf,28,(size >> 16)&0xFFFF);
107 /* We only uppercase if FLAGS2_LONG_PATH_COMPONENTS is zero in the input buf.
108 Strange, but verified on W2K3. Needed for OS/2. JRA. */
109 push_ascii(buf+30,fname,12, uc ? STR_UPPER : 0);
110 DEBUG(8,("put name [%s] from [%s] into dir struct\n",buf+30, fname));
114 /****************************************************************************
115 Initialise the dir bitmap.
116 ****************************************************************************/
118 bool init_dptrs(struct smbd_server_connection *sconn)
120 if (sconn->smb1.searches.dptr_bmap) {
124 sconn->smb1.searches.dptr_bmap = bitmap_allocate(MAX_DIRECTORY_HANDLES);
126 if (sconn->smb1.searches.dptr_bmap == NULL) {
133 /****************************************************************************
134 Idle a dptr - the directory is closed but the control info is kept.
135 ****************************************************************************/
137 static void dptr_idle(struct dptr_struct *dptr)
140 DEBUG(4,("Idling dptr dnum %d\n",dptr->dnum));
141 TALLOC_FREE(dptr->dir_hnd);
145 /****************************************************************************
146 Idle the oldest dptr.
147 ****************************************************************************/
149 static void dptr_idleoldest(struct smbd_server_connection *sconn)
151 struct dptr_struct *dptr;
154 * Go to the end of the list.
156 dptr = DLIST_TAIL(sconn->smb1.searches.dirptrs);
159 DEBUG(0,("No dptrs available to idle ?\n"));
164 * Idle the oldest pointer.
167 for(; dptr; dptr = DLIST_PREV(dptr)) {
175 /****************************************************************************
176 Get the struct dptr_struct for a dir index.
177 ****************************************************************************/
179 static struct dptr_struct *dptr_get(struct smbd_server_connection *sconn,
180 int key, bool forclose)
182 struct dptr_struct *dptr;
184 for(dptr = sconn->smb1.searches.dirptrs; dptr; dptr = dptr->next) {
185 if(dptr->dnum == key) {
186 if (!forclose && !dptr->dir_hnd) {
187 if (sconn->smb1.searches.dirhandles_open >= MAX_OPEN_DIRECTORIES)
188 dptr_idleoldest(sconn);
189 DEBUG(4,("dptr_get: Reopening dptr key %d\n",key));
190 if (!(dptr->dir_hnd = OpenDir(
191 NULL, dptr->conn, dptr->path,
192 dptr->wcard, dptr->attr))) {
193 DEBUG(4,("dptr_get: Failed to open %s (%s)\n",dptr->path,
198 DLIST_PROMOTE(sconn->smb1.searches.dirptrs,dptr);
205 /****************************************************************************
206 Get the dir path for a dir index.
207 ****************************************************************************/
209 char *dptr_path(struct smbd_server_connection *sconn, int key)
211 struct dptr_struct *dptr = dptr_get(sconn, key, false);
217 /****************************************************************************
218 Get the dir wcard for a dir index.
219 ****************************************************************************/
221 char *dptr_wcard(struct smbd_server_connection *sconn, int key)
223 struct dptr_struct *dptr = dptr_get(sconn, key, false);
229 /****************************************************************************
230 Get the dir attrib for a dir index.
231 ****************************************************************************/
233 uint16 dptr_attr(struct smbd_server_connection *sconn, int key)
235 struct dptr_struct *dptr = dptr_get(sconn, key, false);
241 /****************************************************************************
242 Close a dptr (internal func).
243 ****************************************************************************/
245 static void dptr_close_internal(struct dptr_struct *dptr)
247 struct smbd_server_connection *sconn = dptr->conn->sconn;
249 DEBUG(4,("closing dptr key %d\n",dptr->dnum));
255 DLIST_REMOVE(sconn->smb1.searches.dirptrs, dptr);
258 * Free the dnum in the bitmap. Remember the dnum value is always
259 * biased by one with respect to the bitmap.
262 if(bitmap_query(sconn->smb1.searches.dptr_bmap, dptr->dnum - 1) != true) {
263 DEBUG(0,("dptr_close_internal : Error - closing dnum = %d and bitmap not set !\n",
267 bitmap_clear(sconn->smb1.searches.dptr_bmap, dptr->dnum - 1);
270 TALLOC_FREE(dptr->dir_hnd);
272 /* Lanman 2 specific code */
273 SAFE_FREE(dptr->wcard);
274 string_set(&dptr->path,"");
278 /****************************************************************************
279 Close a dptr given a key.
280 ****************************************************************************/
282 void dptr_close(struct smbd_server_connection *sconn, int *key)
284 struct dptr_struct *dptr;
286 if(*key == INVALID_DPTR_KEY)
289 /* OS/2 seems to use -1 to indicate "close all directories" */
291 struct dptr_struct *next;
292 for(dptr = sconn->smb1.searches.dirptrs; dptr; dptr = next) {
294 dptr_close_internal(dptr);
296 *key = INVALID_DPTR_KEY;
300 dptr = dptr_get(sconn, *key, true);
303 DEBUG(0,("Invalid key %d given to dptr_close\n", *key));
307 dptr_close_internal(dptr);
309 *key = INVALID_DPTR_KEY;
312 /****************************************************************************
313 Close all dptrs for a cnum.
314 ****************************************************************************/
316 void dptr_closecnum(connection_struct *conn)
318 struct dptr_struct *dptr, *next;
319 struct smbd_server_connection *sconn = conn->sconn;
325 for(dptr = sconn->smb1.searches.dirptrs; dptr; dptr = next) {
327 if (dptr->conn == conn) {
328 dptr_close_internal(dptr);
333 /****************************************************************************
334 Idle all dptrs for a cnum.
335 ****************************************************************************/
337 void dptr_idlecnum(connection_struct *conn)
339 struct dptr_struct *dptr;
340 struct smbd_server_connection *sconn = conn->sconn;
346 for(dptr = sconn->smb1.searches.dirptrs; dptr; dptr = dptr->next) {
347 if (dptr->conn == conn && dptr->dir_hnd) {
353 /****************************************************************************
354 Close a dptr that matches a given path, only if it matches the spid also.
355 ****************************************************************************/
357 void dptr_closepath(struct smbd_server_connection *sconn,
358 char *path,uint16 spid)
360 struct dptr_struct *dptr, *next;
361 for(dptr = sconn->smb1.searches.dirptrs; dptr; dptr = next) {
363 if (spid == dptr->spid && strequal(dptr->path,path))
364 dptr_close_internal(dptr);
368 /****************************************************************************
369 Try and close the oldest handle not marked for
370 expect close in the hope that the client has
371 finished with that one.
372 ****************************************************************************/
374 static void dptr_close_oldest(struct smbd_server_connection *sconn,
377 struct dptr_struct *dptr;
380 * Go to the end of the list.
382 for(dptr = sconn->smb1.searches.dirptrs; dptr && dptr->next; dptr = dptr->next)
386 DEBUG(0,("No old dptrs available to close oldest ?\n"));
391 * If 'old' is true, close the oldest oldhandle dnum (ie. 1 < dnum < 256) that
392 * does not have expect_close set. If 'old' is false, close
393 * one of the new dnum handles.
396 for(; dptr; dptr = DLIST_PREV(dptr)) {
397 if ((old && (dptr->dnum < 256) && !dptr->expect_close) ||
398 (!old && (dptr->dnum > 255))) {
399 dptr_close_internal(dptr);
405 /****************************************************************************
406 Create a new dir ptr. If the flag old_handle is true then we must allocate
407 from the bitmap range 0 - 255 as old SMBsearch directory handles are only
408 one byte long. If old_handle is false we allocate from the range
409 256 - MAX_DIRECTORY_HANDLES. We bias the number we return by 1 to ensure
410 a directory handle is never zero.
411 wcard must not be zero.
412 ****************************************************************************/
414 NTSTATUS dptr_create(connection_struct *conn, const char *path, bool old_handle, bool expect_close,uint16 spid,
415 const char *wcard, bool wcard_has_wild, uint32 attr, struct dptr_struct **dptr_ret)
417 struct smbd_server_connection *sconn = conn->sconn;
418 struct dptr_struct *dptr = NULL;
419 struct smb_Dir *dir_hnd;
422 DEBUG(5,("dptr_create dir=%s\n", path));
425 DEBUG(0,("dptr_create: called with fake connection_struct\n"));
426 return NT_STATUS_INTERNAL_ERROR;
430 return NT_STATUS_INVALID_PARAMETER;
433 status = check_name(conn,path);
434 if (!NT_STATUS_IS_OK(status)) {
438 dir_hnd = OpenDir(NULL, conn, path, wcard, attr);
440 return map_nt_error_from_unix(errno);
443 if (sconn->smb1.searches.dirhandles_open >= MAX_OPEN_DIRECTORIES) {
444 dptr_idleoldest(sconn);
447 dptr = SMB_MALLOC_P(struct dptr_struct);
449 DEBUG(0,("malloc fail in dptr_create.\n"));
450 TALLOC_FREE(dir_hnd);
451 return NT_STATUS_NO_MEMORY;
459 * This is an old-style SMBsearch request. Ensure the
460 * value we return will fit in the range 1-255.
463 dptr->dnum = bitmap_find(sconn->smb1.searches.dptr_bmap, 0);
465 if(dptr->dnum == -1 || dptr->dnum > 254) {
468 * Try and close the oldest handle not marked for
469 * expect close in the hope that the client has
470 * finished with that one.
473 dptr_close_oldest(sconn, true);
475 /* Now try again... */
476 dptr->dnum = bitmap_find(sconn->smb1.searches.dptr_bmap, 0);
477 if(dptr->dnum == -1 || dptr->dnum > 254) {
478 DEBUG(0,("dptr_create: returned %d: Error - all old dirptrs in use ?\n", dptr->dnum));
480 TALLOC_FREE(dir_hnd);
481 return NT_STATUS_TOO_MANY_OPENED_FILES;
487 * This is a new-style trans2 request. Allocate from
488 * a range that will return 256 - MAX_DIRECTORY_HANDLES.
491 dptr->dnum = bitmap_find(sconn->smb1.searches.dptr_bmap, 255);
493 if(dptr->dnum == -1 || dptr->dnum < 255) {
496 * Try and close the oldest handle close in the hope that
497 * the client has finished with that one. This will only
498 * happen in the case of the Win98 client bug where it leaks
502 dptr_close_oldest(sconn, false);
504 /* Now try again... */
505 dptr->dnum = bitmap_find(sconn->smb1.searches.dptr_bmap, 255);
507 if(dptr->dnum == -1 || dptr->dnum < 255) {
508 DEBUG(0,("dptr_create: returned %d: Error - all new dirptrs in use ?\n", dptr->dnum));
510 TALLOC_FREE(dir_hnd);
511 return NT_STATUS_TOO_MANY_OPENED_FILES;
516 bitmap_set(sconn->smb1.searches.dptr_bmap, dptr->dnum);
518 dptr->dnum += 1; /* Always bias the dnum by one - no zero dnums allowed. */
520 string_set(&dptr->path,path);
522 dptr->dir_hnd = dir_hnd;
524 dptr->expect_close = expect_close;
525 dptr->wcard = SMB_STRDUP(wcard);
527 bitmap_clear(sconn->smb1.searches.dptr_bmap, dptr->dnum - 1);
529 TALLOC_FREE(dir_hnd);
530 return NT_STATUS_NO_MEMORY;
532 if (lp_posix_pathnames() || (wcard[0] == '.' && wcard[1] == 0)) {
533 dptr->has_wild = True;
535 dptr->has_wild = wcard_has_wild;
540 DLIST_ADD(sconn->smb1.searches.dirptrs, dptr);
542 DEBUG(3,("creating new dirptr %d for path %s, expect_close = %d\n",
543 dptr->dnum,path,expect_close));
551 /****************************************************************************
552 Wrapper functions to access the lower level directory handles.
553 ****************************************************************************/
555 int dptr_CloseDir(struct dptr_struct *dptr)
557 struct smbd_server_connection *sconn = dptr->conn->sconn;
558 DLIST_REMOVE(sconn->smb1.searches.dirptrs, dptr);
559 TALLOC_FREE(dptr->dir_hnd);
563 void dptr_SeekDir(struct dptr_struct *dptr, long offset)
565 SeekDir(dptr->dir_hnd, offset);
568 long dptr_TellDir(struct dptr_struct *dptr)
570 return TellDir(dptr->dir_hnd);
573 bool dptr_has_wild(struct dptr_struct *dptr)
575 return dptr->has_wild;
578 int dptr_dnum(struct dptr_struct *dptr)
583 /****************************************************************************
584 Return the next visible file name, skipping veto'd and invisible files.
585 ****************************************************************************/
587 static const char *dptr_normal_ReadDirName(struct dptr_struct *dptr,
588 long *poffset, SMB_STRUCT_STAT *pst,
591 /* Normal search for the next file. */
593 char *talloced = NULL;
595 while ((name = ReadDirName(dptr->dir_hnd, poffset, pst, &talloced))
597 if (is_visible_file(dptr->conn, dptr->path, name, pst, True)) {
598 *ptalloced = talloced;
601 TALLOC_FREE(talloced);
606 /****************************************************************************
607 Return the next visible file name, skipping veto'd and invisible files.
608 ****************************************************************************/
610 char *dptr_ReadDirName(TALLOC_CTX *ctx,
611 struct dptr_struct *dptr,
613 SMB_STRUCT_STAT *pst)
615 struct smb_filename smb_fname_base;
617 const char *name_temp = NULL;
618 char *talloced = NULL;
619 char *pathreal = NULL;
620 char *found_name = NULL;
623 SET_STAT_INVALID(*pst);
625 if (dptr->has_wild || dptr->did_stat) {
626 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst,
628 if (name_temp == NULL) {
631 if (talloced != NULL) {
632 return talloc_move(ctx, &talloced);
634 return talloc_strdup(ctx, name_temp);
637 /* If poffset is -1 then we know we returned this name before and we
638 * have no wildcards. We're at the end of the directory. */
639 if (*poffset == END_OF_DIRECTORY_OFFSET) {
643 /* We know the stored wcard contains no wildcard characters.
644 * See if we can match with a stat call. If we can't, then set
645 * did_stat to true to ensure we only do this once and keep
648 dptr->did_stat = true;
650 /* First check if it should be visible. */
651 if (!is_visible_file(dptr->conn, dptr->path, dptr->wcard,
654 /* This only returns false if the file was found, but
655 is explicitly not visible. Set us to end of
656 directory, but return NULL as we know we can't ever
661 if (VALID_STAT(*pst)) {
662 name = talloc_strdup(ctx, dptr->wcard);
666 pathreal = talloc_asprintf(ctx,
673 /* Create an smb_filename with stream_name == NULL. */
674 ZERO_STRUCT(smb_fname_base);
675 smb_fname_base.base_name = pathreal;
677 if (SMB_VFS_STAT(dptr->conn, &smb_fname_base) == 0) {
678 *pst = smb_fname_base.st;
679 name = talloc_strdup(ctx, dptr->wcard);
682 /* If we get any other error than ENOENT or ENOTDIR
683 then the file exists we just can't stat it. */
684 if (errno != ENOENT && errno != ENOTDIR) {
685 name = talloc_strdup(ctx, dptr->wcard);
690 /* Stat failed. We know this is authoratiative if we are
691 * providing case sensitive semantics or the underlying
692 * filesystem is case sensitive.
694 if (dptr->conn->case_sensitive ||
695 !(dptr->conn->fs_capabilities & FILE_CASE_SENSITIVE_SEARCH))
701 * Try case-insensitive stat if the fs has the ability. This avoids
702 * scanning the whole directory.
704 ret = SMB_VFS_GET_REAL_FILENAME(dptr->conn, dptr->path, dptr->wcard,
709 } else if (errno == ENOENT) {
710 /* The case-insensitive lookup was authoritative. */
714 TALLOC_FREE(pathreal);
716 name_temp = dptr_normal_ReadDirName(dptr, poffset, pst, &talloced);
717 if (name_temp == NULL) {
720 if (talloced != NULL) {
721 return talloc_move(ctx, &talloced);
723 return talloc_strdup(ctx, name_temp);
726 TALLOC_FREE(pathreal);
728 /* We need to set the underlying dir_hnd offset to -1
729 * also as this function is usually called with the
730 * output from TellDir. */
731 dptr->dir_hnd->offset = *poffset = END_OF_DIRECTORY_OFFSET;
735 /****************************************************************************
736 Search for a file by name, skipping veto'ed and not visible files.
737 ****************************************************************************/
739 bool dptr_SearchDir(struct dptr_struct *dptr, const char *name, long *poffset, SMB_STRUCT_STAT *pst)
741 SET_STAT_INVALID(*pst);
743 if (!dptr->has_wild && (dptr->dir_hnd->offset == END_OF_DIRECTORY_OFFSET)) {
744 /* This is a singleton directory and we're already at the end. */
745 *poffset = END_OF_DIRECTORY_OFFSET;
749 return SearchDir(dptr->dir_hnd, name, poffset);
752 /****************************************************************************
753 Add the name we're returning into the underlying cache.
754 ****************************************************************************/
756 void dptr_DirCacheAdd(struct dptr_struct *dptr, const char *name, long offset)
758 DirCacheAdd(dptr->dir_hnd, name, offset);
761 /****************************************************************************
762 Initialize variables & state data at the beginning of all search SMB requests.
763 ****************************************************************************/
764 void dptr_init_search_op(struct dptr_struct *dptr)
766 SMB_VFS_INIT_SEARCH_OP(dptr->conn, dptr->dir_hnd->dir);
769 /****************************************************************************
770 Fill the 5 byte server reserved dptr field.
771 ****************************************************************************/
773 bool dptr_fill(struct smbd_server_connection *sconn,
774 char *buf1,unsigned int key)
776 unsigned char *buf = (unsigned char *)buf1;
777 struct dptr_struct *dptr = dptr_get(sconn, key, false);
780 DEBUG(1,("filling null dirptr %d\n",key));
783 offset = (uint32)TellDir(dptr->dir_hnd);
784 DEBUG(6,("fill on key %u dirptr 0x%lx now at %d\n",key,
785 (long)dptr->dir_hnd,(int)offset));
791 /****************************************************************************
792 Fetch the dir ptr and seek it given the 5 byte server field.
793 ****************************************************************************/
795 struct dptr_struct *dptr_fetch(struct smbd_server_connection *sconn,
798 unsigned int key = *(unsigned char *)buf;
799 struct dptr_struct *dptr = dptr_get(sconn, key, false);
804 DEBUG(3,("fetched null dirptr %d\n",key));
808 offset = IVAL(buf,1);
809 if (offset == (uint32)-1) {
810 seekoff = END_OF_DIRECTORY_OFFSET;
812 seekoff = (long)offset;
814 SeekDir(dptr->dir_hnd,seekoff);
815 DEBUG(3,("fetching dirptr %d for path %s at offset %d\n",
816 key, dptr->path, (int)seekoff));
820 /****************************************************************************
822 ****************************************************************************/
824 struct dptr_struct *dptr_fetch_lanman2(struct smbd_server_connection *sconn,
827 struct dptr_struct *dptr = dptr_get(sconn, dptr_num, false);
830 DEBUG(3,("fetched null dirptr %d\n",dptr_num));
833 DEBUG(3,("fetching dirptr %d for path %s\n",dptr_num,dptr->path));
837 /****************************************************************************
838 Check that a file matches a particular file type.
839 ****************************************************************************/
841 bool dir_check_ftype(connection_struct *conn, uint32 mode, uint32 dirtype)
845 /* Check the "may have" search bits. */
846 if (((mode & ~dirtype) & (aHIDDEN | aSYSTEM | aDIR)) != 0)
849 /* Check the "must have" bits, which are the may have bits shifted eight */
850 /* If must have bit is set, the file/dir can not be returned in search unless the matching
851 file attribute is set */
852 mask = ((dirtype >> 8) & (aDIR|aARCH|aRONLY|aHIDDEN|aSYSTEM)); /* & 0x37 */
854 if((mask & (mode & (aDIR|aARCH|aRONLY|aHIDDEN|aSYSTEM))) == mask) /* check if matching attribute present */
863 static bool mangle_mask_match(connection_struct *conn,
864 const char *filename,
869 if (!name_to_8_3(filename,mname,False,conn->params)) {
872 return mask_match_search(mname,mask,False);
875 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
876 struct dptr_struct *dirptr,
881 bool (*match_fn)(TALLOC_CTX *ctx,
886 bool (*mode_fn)(TALLOC_CTX *ctx,
888 struct smb_filename *smb_fname,
892 struct smb_filename **_smb_fname,
896 connection_struct *conn = dirptr->conn;
902 needslash = ( dirptr->path[strlen(dirptr->path) -1] != '/');
907 SMB_STRUCT_STAT sbuf;
911 char *pathreal = NULL;
912 struct smb_filename smb_fname;
917 cur_offset = dptr_TellDir(dirptr);
918 prev_offset = cur_offset;
919 dname = dptr_ReadDirName(ctx, dirptr, &cur_offset, &sbuf);
921 DEBUG(6,("smbd_dirptr_get_entry: dirptr 0x%lx now at offset %ld\n",
922 (long)dirptr, cur_offset));
928 isdots = (ISDOT(dname) || ISDOTDOT(dname));
929 if (dont_descend && !isdots) {
935 * fname may get mangled, dname is never mangled.
936 * Whenever we're accessing the filesystem we use
937 * pathreal which is composed from dname.
940 ok = match_fn(ctx, private_data, dname, mask, &fname);
946 pathreal = talloc_asprintf(ctx, "%s%s%s",
956 /* Create smb_fname with NULL stream_name. */
957 ZERO_STRUCT(smb_fname);
958 smb_fname.base_name = pathreal;
961 ok = mode_fn(ctx, private_data, &smb_fname, &mode);
965 TALLOC_FREE(pathreal);
969 if (!dir_check_ftype(conn, mode, dirtype)) {
970 DEBUG(5,("[%s] attribs 0x%x didn't match 0x%x\n",
971 fname, (unsigned int)mode, (unsigned int)dirtype));
974 TALLOC_FREE(pathreal);
979 struct timespec write_time_ts;
980 struct file_id fileid;
982 fileid = vfs_file_id_from_sbuf(conn,
984 get_file_infos(fileid, NULL, &write_time_ts);
985 if (!null_timespec(write_time_ts)) {
986 update_stat_ex_mtime(&smb_fname.st,
991 DEBUG(3,("smbd_dirptr_get_entry mask=[%s] found %s "
993 mask, smb_fname_str_dbg(&smb_fname),
996 DirCacheAdd(dirptr->dir_hnd, dname, cur_offset);
1000 status = copy_smb_filename(ctx, &smb_fname, _smb_fname);
1001 TALLOC_FREE(pathreal);
1002 if (!NT_STATUS_IS_OK(status)) {
1007 *_prev_offset = prev_offset;
1015 /****************************************************************************
1016 Get an 8.3 directory entry.
1017 ****************************************************************************/
1019 static bool smbd_dirptr_8_3_match_fn(TALLOC_CTX *ctx,
1025 connection_struct *conn = (connection_struct *)private_data;
1027 if ((strcmp(mask,"*.*") == 0) ||
1028 mask_match_search(dname, mask, false) ||
1029 mangle_mask_match(conn, dname, mask)) {
1033 if (!mangle_is_8_3(dname, false, conn->params)) {
1034 bool ok = name_to_8_3(dname, mname, false,
1044 *_fname = talloc_strdup(ctx, fname);
1045 if (*_fname == NULL) {
1055 static bool smbd_dirptr_8_3_mode_fn(TALLOC_CTX *ctx,
1057 struct smb_filename *smb_fname,
1060 connection_struct *conn = (connection_struct *)private_data;
1062 if (!VALID_STAT(smb_fname->st)) {
1063 if ((SMB_VFS_STAT(conn, smb_fname)) != 0) {
1064 DEBUG(5,("smbd_dirptr_8_3_mode_fn: "
1065 "Couldn't stat [%s]. Error "
1067 smb_fname_str_dbg(smb_fname),
1073 *_mode = dos_mode(conn, smb_fname);
1077 bool get_dir_entry(TALLOC_CTX *ctx,
1078 struct dptr_struct *dirptr,
1084 struct timespec *_date,
1088 connection_struct *conn = dirptr->conn;
1090 struct smb_filename *smb_fname = NULL;
1095 ok = smbd_dirptr_get_entry(ctx,
1101 smbd_dirptr_8_3_match_fn,
1102 smbd_dirptr_8_3_mode_fn,
1112 *_fname = talloc_move(ctx, &fname);
1113 *_size = smb_fname->st.st_ex_size;
1115 *_date = smb_fname->st.st_ex_mtime;
1116 TALLOC_FREE(smb_fname);
1120 /*******************************************************************
1121 Check to see if a user can read a file. This is only approximate,
1122 it is used as part of the "hide unreadable" option. Don't
1123 use it for anything security sensitive.
1124 ********************************************************************/
1126 static bool user_can_read_file(connection_struct *conn,
1127 struct smb_filename *smb_fname)
1130 * If user is a member of the Admin group
1131 * we never hide files from them.
1132 * Use (uid_t)0 here not sec_initial_uid()
1133 * because of the RAW-SAMBA3HIDE test.
1136 if (get_current_uid(conn) == (uid_t)0) {
1140 return can_access_file_acl(conn, smb_fname, FILE_READ_DATA);
1143 /*******************************************************************
1144 Check to see if a user can write a file (and only files, we do not
1145 check dirs on this one). This is only approximate,
1146 it is used as part of the "hide unwriteable" option. Don't
1147 use it for anything security sensitive.
1148 ********************************************************************/
1150 static bool user_can_write_file(connection_struct *conn,
1151 const struct smb_filename *smb_fname)
1154 * If user is a member of the Admin group
1155 * we never hide files from them.
1156 * Use (uid_t)0 here not sec_initial_uid()
1157 * because of the RAW-SAMBA3HIDE test.
1160 if (get_current_uid(conn) == (uid_t)0) {
1164 SMB_ASSERT(VALID_STAT(smb_fname->st));
1166 /* Pseudo-open the file */
1168 if(S_ISDIR(smb_fname->st.st_ex_mode)) {
1172 return can_write_to_file(conn, smb_fname);
1175 /*******************************************************************
1176 Is a file a "special" type ?
1177 ********************************************************************/
1179 static bool file_is_special(connection_struct *conn,
1180 const struct smb_filename *smb_fname)
1183 * If user is a member of the Admin group
1184 * we never hide files from them.
1185 * Use (uid_t)0 here not sec_initial_uid()
1186 * because of the RAW-SAMBA3HIDE test.
1189 if (get_current_uid(conn) == (uid_t)0) {
1193 SMB_ASSERT(VALID_STAT(smb_fname->st));
1195 if (S_ISREG(smb_fname->st.st_ex_mode) ||
1196 S_ISDIR(smb_fname->st.st_ex_mode) ||
1197 S_ISLNK(smb_fname->st.st_ex_mode))
1203 /*******************************************************************
1204 Should the file be seen by the client?
1205 NOTE: A successful return is no guarantee of the file's existence.
1206 ********************************************************************/
1208 bool is_visible_file(connection_struct *conn, const char *dir_path,
1209 const char *name, SMB_STRUCT_STAT *pst, bool use_veto)
1211 bool hide_unreadable = lp_hideunreadable(SNUM(conn));
1212 bool hide_unwriteable = lp_hideunwriteable_files(SNUM(conn));
1213 bool hide_special = lp_hide_special_files(SNUM(conn));
1215 struct smb_filename *smb_fname_base = NULL;
1219 if ((strcmp(".",name) == 0) || (strcmp("..",name) == 0)) {
1220 return True; /* . and .. are always visible. */
1223 /* If it's a vetoed file, pretend it doesn't even exist */
1224 if (use_veto && IS_VETO_PATH(conn, name)) {
1225 DEBUG(10,("is_visible_file: file %s is vetoed.\n", name ));
1229 if (hide_unreadable || hide_unwriteable || hide_special) {
1230 entry = talloc_asprintf(talloc_tos(), "%s/%s", dir_path, name);
1236 /* Create an smb_filename with stream_name == NULL. */
1237 status = create_synthetic_smb_fname(talloc_tos(), entry, NULL,
1238 pst, &smb_fname_base);
1239 if (!NT_STATUS_IS_OK(status)) {
1244 /* If the file name does not exist, there's no point checking
1245 * the configuration options. We succeed, on the basis that the
1246 * checks *might* have passed if the file was present.
1248 if (!VALID_STAT(*pst)) {
1249 if (SMB_VFS_STAT(conn, smb_fname_base) != 0) {
1253 *pst = smb_fname_base->st;
1257 /* Honour _hide unreadable_ option */
1258 if (hide_unreadable &&
1259 !user_can_read_file(conn, smb_fname_base)) {
1260 DEBUG(10,("is_visible_file: file %s is unreadable.\n",
1265 /* Honour _hide unwriteable_ option */
1266 if (hide_unwriteable && !user_can_write_file(conn,
1268 DEBUG(10,("is_visible_file: file %s is unwritable.\n",
1273 /* Honour _hide_special_ option */
1274 if (hide_special && file_is_special(conn, smb_fname_base)) {
1275 DEBUG(10,("is_visible_file: file %s is special.\n",
1284 TALLOC_FREE(smb_fname_base);
1289 static int smb_Dir_destructor(struct smb_Dir *dirp)
1292 SMB_VFS_CLOSEDIR(dirp->conn,dirp->dir);
1294 if (dirp->conn->sconn) {
1295 dirp->conn->sconn->smb1.searches.dirhandles_open--;
1300 /*******************************************************************
1302 ********************************************************************/
1304 struct smb_Dir *OpenDir(TALLOC_CTX *mem_ctx, connection_struct *conn,
1305 const char *name, const char *mask, uint32 attr)
1307 struct smb_Dir *dirp = TALLOC_ZERO_P(mem_ctx, struct smb_Dir);
1308 struct smbd_server_connection *sconn = conn->sconn;
1315 dirp->name_cache_size = lp_directory_name_cache_size(SNUM(conn));
1317 dirp->dir_path = talloc_strdup(dirp, name);
1318 if (!dirp->dir_path) {
1324 sconn->smb1.searches.dirhandles_open++;
1326 talloc_set_destructor(dirp, smb_Dir_destructor);
1328 dirp->dir = SMB_VFS_OPENDIR(conn, dirp->dir_path, mask, attr);
1330 DEBUG(5,("OpenDir: Can't open %s. %s\n", dirp->dir_path,
1342 /*******************************************************************
1343 Read from a directory.
1344 Return directory entry, current offset, and optional stat information.
1345 Don't check for veto or invisible files.
1346 ********************************************************************/
1348 const char *ReadDirName(struct smb_Dir *dirp, long *poffset,
1349 SMB_STRUCT_STAT *sbuf, char **ptalloced)
1352 char *talloced = NULL;
1353 connection_struct *conn = dirp->conn;
1355 /* Cheat to allow . and .. to be the first entries returned. */
1356 if (((*poffset == START_OF_DIRECTORY_OFFSET) ||
1357 (*poffset == DOT_DOT_DIRECTORY_OFFSET)) && (dirp->file_number < 2))
1359 if (dirp->file_number == 0) {
1361 *poffset = dirp->offset = START_OF_DIRECTORY_OFFSET;
1364 *poffset = dirp->offset = DOT_DOT_DIRECTORY_OFFSET;
1366 dirp->file_number++;
1369 } else if (*poffset == END_OF_DIRECTORY_OFFSET) {
1370 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1373 /* A real offset, seek to it. */
1374 SeekDir(dirp, *poffset);
1377 while ((n = vfs_readdirname(conn, dirp->dir, sbuf, &talloced))) {
1378 /* Ignore . and .. - we've already returned them. */
1380 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
1381 TALLOC_FREE(talloced);
1385 *poffset = dirp->offset = SMB_VFS_TELLDIR(conn, dirp->dir);
1386 *ptalloced = talloced;
1387 dirp->file_number++;
1390 *poffset = dirp->offset = END_OF_DIRECTORY_OFFSET;
1395 /*******************************************************************
1396 Rewind to the start.
1397 ********************************************************************/
1399 void RewindDir(struct smb_Dir *dirp, long *poffset)
1401 SMB_VFS_REWINDDIR(dirp->conn, dirp->dir);
1402 dirp->file_number = 0;
1403 dirp->offset = START_OF_DIRECTORY_OFFSET;
1404 *poffset = START_OF_DIRECTORY_OFFSET;
1407 /*******************************************************************
1409 ********************************************************************/
1411 void SeekDir(struct smb_Dir *dirp, long offset)
1413 if (offset != dirp->offset) {
1414 if (offset == START_OF_DIRECTORY_OFFSET) {
1415 RewindDir(dirp, &offset);
1417 * Ok we should really set the file number here
1418 * to 1 to enable ".." to be returned next. Trouble
1419 * is I'm worried about callers using SeekDir(dirp,0)
1420 * as equivalent to RewindDir(). So leave this alone
1423 } else if (offset == DOT_DOT_DIRECTORY_OFFSET) {
1424 RewindDir(dirp, &offset);
1426 * Set the file number to 2 - we want to get the first
1427 * real file entry (the one we return after "..")
1428 * on the next ReadDir.
1430 dirp->file_number = 2;
1431 } else if (offset == END_OF_DIRECTORY_OFFSET) {
1432 ; /* Don't seek in this case. */
1434 SMB_VFS_SEEKDIR(dirp->conn, dirp->dir, offset);
1436 dirp->offset = offset;
1440 /*******************************************************************
1441 Tell a dir position.
1442 ********************************************************************/
1444 long TellDir(struct smb_Dir *dirp)
1446 return(dirp->offset);
1449 /*******************************************************************
1450 Add an entry into the dcache.
1451 ********************************************************************/
1453 void DirCacheAdd(struct smb_Dir *dirp, const char *name, long offset)
1455 struct name_cache_entry *e;
1457 if (dirp->name_cache_size == 0) {
1461 if (dirp->name_cache == NULL) {
1462 dirp->name_cache = TALLOC_ZERO_ARRAY(
1463 dirp, struct name_cache_entry, dirp->name_cache_size);
1465 if (dirp->name_cache == NULL) {
1470 dirp->name_cache_index = (dirp->name_cache_index+1) %
1471 dirp->name_cache_size;
1472 e = &dirp->name_cache[dirp->name_cache_index];
1473 TALLOC_FREE(e->name);
1474 e->name = talloc_strdup(dirp, name);
1478 /*******************************************************************
1479 Find an entry by name. Leave us at the offset after it.
1480 Don't check for veto or invisible files.
1481 ********************************************************************/
1483 bool SearchDir(struct smb_Dir *dirp, const char *name, long *poffset)
1486 const char *entry = NULL;
1487 char *talloced = NULL;
1488 connection_struct *conn = dirp->conn;
1490 /* Search back in the name cache. */
1491 if (dirp->name_cache_size && dirp->name_cache) {
1492 for (i = dirp->name_cache_index; i >= 0; i--) {
1493 struct name_cache_entry *e = &dirp->name_cache[i];
1494 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1495 *poffset = e->offset;
1496 SeekDir(dirp, e->offset);
1500 for (i = dirp->name_cache_size - 1; i > dirp->name_cache_index; i--) {
1501 struct name_cache_entry *e = &dirp->name_cache[i];
1502 if (e->name && (conn->case_sensitive ? (strcmp(e->name, name) == 0) : strequal(e->name, name))) {
1503 *poffset = e->offset;
1504 SeekDir(dirp, e->offset);
1510 /* Not found in the name cache. Rewind directory and start from scratch. */
1511 SMB_VFS_REWINDDIR(conn, dirp->dir);
1512 dirp->file_number = 0;
1513 *poffset = START_OF_DIRECTORY_OFFSET;
1514 while ((entry = ReadDirName(dirp, poffset, NULL, &talloced))) {
1515 if (conn->case_sensitive ? (strcmp(entry, name) == 0) : strequal(entry, name)) {
1516 TALLOC_FREE(talloced);
1519 TALLOC_FREE(talloced);
1524 /*****************************************************************
1525 Is this directory empty ?
1526 *****************************************************************/
1528 NTSTATUS can_delete_directory(struct connection_struct *conn,
1529 const char *dirname)
1531 NTSTATUS status = NT_STATUS_OK;
1533 const char *dname = NULL;
1534 char *talloced = NULL;
1536 struct smb_Dir *dir_hnd = OpenDir(talloc_tos(), conn, dirname,
1540 return map_nt_error_from_unix(errno);
1543 while ((dname = ReadDirName(dir_hnd, &dirpos, &st, &talloced))) {
1544 /* Quick check for "." and ".." */
1545 if (dname[0] == '.') {
1546 if (!dname[1] || (dname[1] == '.' && !dname[2])) {
1547 TALLOC_FREE(talloced);
1552 if (!is_visible_file(conn, dirname, dname, &st, True)) {
1553 TALLOC_FREE(talloced);
1557 DEBUG(10,("can_delete_directory: got name %s - can't delete\n",
1559 status = NT_STATUS_DIRECTORY_NOT_EMPTY;
1562 TALLOC_FREE(talloced);
1563 TALLOC_FREE(dir_hnd);