1 /* find -- search for files in a directory hierarchy (fts version)
2 Copyright (C) 1990, 91, 92, 93, 94, 2000,
3 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20 /* This file was written by James Youngman, based on find.c.
22 GNU find was written by Eric Decker <cire@cisco.com>,
23 with enhancements by David MacKenzie <djm@gnu.org>,
24 Jay Plett <jay@silence.princeton.nj.us>,
25 and Tim Wood <axolotl!tim@toad.com>.
26 The idea for -print0 and xargs -0 came from
27 Dan Bernstein <brnstnd@kramden.acf.nyu.edu>.
34 #define USE_SAFE_CHDIR 1
35 #undef STAT_MOUNTPOINTS
48 #if defined(HAVE_FCNTL_H)
52 #include "../gnulib/lib/xalloc.h"
67 # define _(Text) gettext (Text)
70 #define textdomain(Domain)
71 #define bindtextdomain(Package, Directory)
74 # define N_(String) gettext_noop (String)
76 /* See locate.c for explanation as to why not use (String) */
77 # define N_(String) String
81 static void set_close_on_exec(int fd
)
83 #if defined(F_GETFD) && defined(FD_CLOEXEC)
85 flags
= fcntl(fd
, F_GETFD
);
89 fcntl(fd
, F_SETFD
, flags
);
96 /* FTS_TIGHT_CYCLE_CHECK tries to work around Savannah bug #17877
97 * (but actually using it doesn't fix the bug).
99 static int ftsoptions
= FTS_NOSTAT
|FTS_TIGHT_CYCLE_CHECK
;
101 static int prev_depth
= INT_MIN
; /* fts_level can be < 0 */
102 static int curr_fd
= -1;
104 int get_current_dirfd(void)
106 if (ftsoptions
& FTS_CWDFD
)
108 assert(curr_fd
!= -1);
109 assert( (AT_FDCWD
== curr_fd
) || (curr_fd
>= 0) );
111 if (AT_FDCWD
== curr_fd
)
112 return starting_desc
;
122 static void left_dir(void)
124 if (ftsoptions
& FTS_CWDFD
)
139 * Signal that we are now inside a directory pointed to by dirfd.
140 * The caller can't tell if this is the first time this happens, so
141 * we have to be careful not to call dup() more than once
143 static void inside_dir(int dirfd
)
145 if (ftsoptions
& FTS_CWDFD
)
147 assert(dirfd
== AT_FDCWD
|| dirfd
>= 0);
149 state
.cwd_dir_fd
= dirfd
;
152 if (AT_FDCWD
== dirfd
)
158 curr_fd
= dup(dirfd
);
159 set_close_on_exec(curr_fd
);
163 /* curr_fd is invalid, but dirfd is also invalid.
164 * This should not have happened.
166 assert(curr_fd
>= 0 || dirfd
>= 0);
172 /* FTS_CWDFD is not in use. We can always assume that
173 * AT_FDCWD refers to the directory we are currentl searching.
175 * Therefore there is nothing to do.
182 #ifdef STAT_MOUNTPOINTS
183 static void init_mounted_dev_list(void);
186 /* We have encountered an error which should affect the exit status.
187 * This is normally used to change the exit status from 0 to 1.
188 * However, if the exit status is already 2 for example, we don't want to
192 error_severity(int level
)
194 if (state
.exit_status
< level
)
195 state
.exit_status
= level
;
199 #define STRINGIFY(X) #X
200 #define HANDLECASE(N) case N: return #N;
203 get_fts_info_name(int info
)
210 HANDLECASE(FTS_DEFAULT
);
216 HANDLECASE(FTS_INIT
);
218 HANDLECASE(FTS_NSOK
);
220 HANDLECASE(FTS_SLNONE
);
223 sprintf(buf
, "[%d]", info
);
229 visit(FTS
*p
, FTSENT
*ent
, struct stat
*pstat
)
231 struct predicate
*eval_tree
;
233 state
.curdepth
= ent
->fts_level
;
234 state
.have_stat
= (ent
->fts_info
!= FTS_NS
) && (ent
->fts_info
!= FTS_NSOK
);
235 state
.rel_pathname
= ent
->fts_accpath
;
236 state
.cwd_dir_fd
= p
->fts_cwd_fd
;
238 /* Apply the predicates to this path. */
239 eval_tree
= get_eval_tree();
240 apply_predicate(ent
->fts_path
, pstat
, eval_tree
);
242 /* Deal with any side effects of applying the predicates. */
243 if (state
.stop_at_current_level
)
245 fts_set(p
, ent
, FTS_SKIP
);
250 partial_quotearg_n(int n
, char *s
, size_t len
, enum quoting_style style
)
254 return quotearg_n_style(n
, style
, "");
263 result
= quotearg_n_style(n
, style
, s
);
270 /* We've detected a filesystem loop. This is caused by one of
273 * 1. Option -L is in effect and we've hit a symbolic link that
274 * points to an ancestor. This is harmless. We won't traverse the
277 * 2. We have hit a real cycle in the directory hierarchy. In this
278 * case, we issue a diagnostic message (POSIX requires this) and we
279 * skip that directory entry.
282 issue_loop_warning(FTSENT
* ent
)
284 if (S_ISLNK(ent
->fts_statp
->st_mode
))
287 _("Symbolic link %s is part of a loop in the directory hierarchy; we have already visited the directory to which it points."),
288 safely_quote_err_filename(0, ent
->fts_path
));
292 /* We have found an infinite loop. POSIX requires us to
293 * issue a diagnostic. Usually we won't get to here
294 * because when the leaf optimisation is on, it will cause
295 * the subdirectory to be skipped. If /a/b/c/d is a hard
296 * link to /a/b, then the link count of /a/b/c is 2,
297 * because the ".." entry of /a/b/c/d points to /a, not
301 _("Filesystem loop detected; "
302 "%s is part of the same filesystem loop as %s."),
303 safely_quote_err_filename(0, ent
->fts_path
),
304 partial_quotearg_n(1,
305 ent
->fts_cycle
->fts_path
,
306 ent
->fts_cycle
->fts_pathlen
,
307 options
.err_quoting_style
));
312 * Return true if NAME corresponds to a file which forms part of a
313 * symbolic link loop. The command
314 * rm -f a b; ln -s a b; ln -s b a
315 * produces such a loop.
318 symlink_loop(const char *name
)
322 if (following_links())
323 rv
= stat(name
, &stbuf
);
325 rv
= lstat(name
, &stbuf
);
326 return (0 != rv
) && (ELOOP
== errno
);
331 complete_execdirs_cb(void *context
)
334 /* By the tme this callback is called, the current directory is correct. */
335 complete_pending_execdirs(AT_FDCWD
);
339 show_outstanding_execdirs(FILE *fp
)
341 if (options
.debug_options
& DebugExec
)
346 fprintf(fp
, "Outstanding execdirs:");
352 if (pred_is(p
, pred_execdir
))
354 else if (pred_is(p
, pred_okdir
))
361 const struct exec_val
*execp
= &p
->args
.exec_vec
;
364 fprintf(fp
, "%s ", pfx
);
366 fprintf(fp
, "multiple ");
367 fprintf(fp
, "%d args: ", execp
->state
.cmd_argc
);
368 for (i
=0; i
<execp
->state
.cmd_argc
; ++i
)
370 fprintf(fp
, "%s ", execp
->state
.cmd_argv
[i
]);
377 fprintf(fp
, " none\n");
381 /* No debug output is wanted. */
389 consider_visiting(FTS
*p
, FTSENT
*ent
)
396 if (options
.debug_options
& DebugSearch
)
398 "consider_visiting: fts_info=%-6s, fts_level=%2d, prev_depth=%d "
399 "fts_path=%s, fts_accpath=%s\n",
400 get_fts_info_name(ent
->fts_info
),
401 (int)ent
->fts_level
, prev_depth
,
402 quotearg_n_style(0, options
.err_quoting_style
, ent
->fts_path
),
403 quotearg_n_style(1, options
.err_quoting_style
, ent
->fts_accpath
));
405 if (ent
->fts_info
== FTS_DP
)
409 else if (ent
->fts_level
> prev_depth
|| ent
->fts_level
==0)
413 inside_dir(p
->fts_cwd_fd
);
414 prev_depth
= ent
->fts_level
;
417 /* Cope with various error conditions. */
418 if (ent
->fts_info
== FTS_ERR
419 || ent
->fts_info
== FTS_DNR
)
421 error(0, ent
->fts_errno
, "%s",
422 safely_quote_err_filename(0, ent
->fts_path
));
426 else if (ent
->fts_info
== FTS_DC
)
428 issue_loop_warning(ent
);
432 else if (ent
->fts_info
== FTS_SLNONE
)
434 /* fts_read() claims that ent->fts_accpath is a broken symbolic
435 * link. That would be fine, but if this is part of a symbolic
436 * link loop, we diagnose the problem and also ensure that the
437 * eventual return value is nonzero. Note that while the path
438 * we stat is local (fts_accpath), we print the fill path name
439 * of the file (fts_path) in the error message.
441 if (symlink_loop(ent
->fts_accpath
))
443 error(0, ELOOP
, "%s", safely_quote_err_filename(0, ent
->fts_path
));
448 else if (ent
->fts_info
== FTS_NS
)
450 if (ent
->fts_level
== 0)
452 /* e.g., nonexistent starting point */
453 error(0, ent
->fts_errno
, "%s",
454 safely_quote_err_filename(0, ent
->fts_path
));
455 error_severity(1); /* remember problem */
460 /* The following if statement fixes Savannah bug #19605
461 * (failure to diagnose a symbolic link loop)
463 if (symlink_loop(ent
->fts_accpath
))
465 error(0, ELOOP
, "%s",
466 safely_quote_err_filename(0, ent
->fts_path
));
473 /* Cope with the usual cases. */
474 if (ent
->fts_info
== FTS_NSOK
475 || ent
->fts_info
== FTS_NS
/* e.g. symlink loop */)
477 assert(!state
.have_stat
);
478 assert(!state
.have_type
);
479 state
.type
= mode
= 0;
483 state
.have_stat
= true;
484 state
.have_type
= true;
485 statbuf
= *(ent
->fts_statp
);
486 state
.type
= mode
= statbuf
.st_mode
;
491 if (!digest_mode(mode
, ent
->fts_path
, ent
->fts_name
, &statbuf
, 0))
495 /* examine this item. */
497 isdir
= S_ISDIR(statbuf
.st_mode
)
498 || (FTS_D
== ent
->fts_info
)
499 || (FTS_DP
== ent
->fts_info
)
500 || (FTS_DC
== ent
->fts_info
);
502 if (isdir
&& (ent
->fts_info
== FTS_NSOK
))
504 /* This is a directory, but fts did not stat it, so
505 * presumably would not be planning to search its
506 * children. Force a stat of the file so that the
507 * children can be checked.
509 fts_set(p
, ent
, FTS_AGAIN
);
513 if (options
.maxdepth
>= 0)
515 if (ent
->fts_level
>= options
.maxdepth
)
517 fts_set(p
, ent
, FTS_SKIP
); /* descend no further */
519 if (ent
->fts_level
> options
.maxdepth
)
520 ignore
= 1; /* don't even look at this one */
524 if ( (ent
->fts_info
== FTS_D
) && !options
.do_dir_first
)
526 /* this is the preorder visit, but user said -depth */
529 else if ( (ent
->fts_info
== FTS_DP
) && options
.do_dir_first
)
531 /* this is the postorder visit, but user didn't say -depth */
534 else if (ent
->fts_level
< options
.mindepth
)
541 visit(p
, ent
, &statbuf
);
544 /* XXX: if we allow a build-up of pending arguments for "-execdir foo {} +"
545 * we need to execute them in the same directory as we found the item.
546 * If we are trying to do "find a -execdir echo {} +", we will need to
548 * a while in the original working directory
550 * c while in b (just before leaving b)
552 * These restrictions are hard to satisfy while using fts(). The reason is
553 * that it doesn't tell us just before we leave a directory. For the moment,
554 * we punt and don't allow the arguments to build up.
556 if (state
.execdirs_outstanding
)
558 show_outstanding_execdirs(stderr
);
559 run_in_dir(p
->fts_cwd_fd
, complete_execdirs_cb
);
562 if (ent
->fts_info
== FTS_DP
)
564 /* we're leaving a directory. */
565 state
.stop_at_current_level
= false;
579 state
.starting_path_length
= strlen(arg
);
580 inside_dir(AT_FDCWD
);
585 switch (options
.symlink_handling
)
587 case SYMLINK_ALWAYS_DEREF
:
588 ftsoptions
|= FTS_COMFOLLOW
|FTS_LOGICAL
;
591 case SYMLINK_DEREF_ARGSONLY
:
592 ftsoptions
|= FTS_COMFOLLOW
|FTS_PHYSICAL
;
595 case SYMLINK_NEVER_DEREF
:
596 ftsoptions
|= FTS_PHYSICAL
;
600 if (options
.stay_on_filesystem
)
601 ftsoptions
|= FTS_XDEV
;
603 p
= fts_open(arglist
, ftsoptions
, NULL
);
606 error (0, errno
, _("cannot search %s"),
607 safely_quote_err_filename(0, arg
));
611 while ( (ent
=fts_read(p
)) != NULL
)
613 state
.have_stat
= false;
614 state
.have_type
= false;
616 consider_visiting(p
, ent
);
625 process_all_startpoints(int argc
, char *argv
[])
629 /* figure out how many start points there are */
630 for (i
= 0; i
< argc
&& !looks_like_expression(argv
[i
], true); i
++)
632 state
.starting_path_length
= strlen(argv
[i
]); /* TODO: is this redundant? */
639 * We use a temporary variable here because some actions modify
640 * the path temporarily. Hence if we use a string constant,
641 * we get a coredump. The best example of this is if we say
642 * "find -printf %H" (note, not "find . -printf %H").
644 char defaultpath
[2] = ".";
653 main (int argc
, char **argv
)
655 int end_of_leading_options
= 0; /* First arg after any -H/-L etc. */
656 struct predicate
*eval_tree
;
658 program_name
= argv
[0];
659 state
.exit_status
= 0;
660 state
.execdirs_outstanding
= false;
661 state
.cwd_dir_fd
= AT_FDCWD
;
663 /* Set the option defaults before we do the the locale
664 * initialisation as check_nofollow() needs to be executed in the
667 set_option_defaults(&options
);
669 #ifdef HAVE_SETLOCALE
670 setlocale (LC_ALL
, "");
673 bindtextdomain (PACKAGE
, LOCALEDIR
);
674 textdomain (PACKAGE
);
675 atexit (close_stdout
);
677 /* Check for -P, -H or -L options. Also -D and -O, which are
678 * both GNU extensions.
680 end_of_leading_options
= process_leading_options(argc
, argv
);
682 if (options
.debug_options
& DebugStat
)
683 options
.xstat
= debug_stat
;
686 fprintf (stderr
, "cur_day_start = %s", ctime (&options
.cur_day_start
));
690 /* We are now processing the part of the "find" command line
691 * after the -H/-L options (if any).
693 eval_tree
= build_expression_tree(argc
, argv
, end_of_leading_options
);
695 /* safely_chdir() needs to check that it has ended up in the right place.
696 * To avoid bailing out when something gets automounted, it checks if
697 * the target directory appears to have had a directory mounted on it as
698 * we chdir()ed. The problem with this is that in order to notice that
699 * a filesystem was mounted, we would need to lstat() all the mount points.
700 * That strategy loses if our machine is a client of a dead NFS server.
702 * Hence if safely_chdir() and wd_sanity_check() can manage without needing
703 * to know the mounted device list, we do that.
705 if (!options
.open_nofollow_available
)
707 #ifdef STAT_MOUNTPOINTS
708 init_mounted_dev_list();
713 starting_desc
= open (".", O_RDONLY
714 #if defined O_LARGEFILE
718 if (0 <= starting_desc
&& fchdir (starting_desc
) != 0)
720 close (starting_desc
);
723 if (starting_desc
< 0)
725 starting_dir
= xgetcwd ();
727 error (1, errno
, _("cannot get current directory"));
731 process_all_startpoints(argc
-end_of_leading_options
, argv
+end_of_leading_options
);
733 /* If "-exec ... {} +" has been used, there may be some
734 * partially-full command lines which have been built,
735 * but which are not yet complete. Execute those now.
737 show_success_rates(eval_tree
);
739 return state
.exit_status
;
743 is_fts_enabled(int *fts_options
)
745 /* this version of find (i.e. this main()) uses fts. */
746 *fts_options
= ftsoptions
;