5 use warnings::register;
11 # Modified to ensure sub-directory traversal order is not inverded by stack
12 # push and pops. That is remains in the same order as in the directory file,
13 # or user pre-processing (EG:sorted).
18 File::Find - Traverse a directory tree.
23 find(\&wanted, @directories_to_search);
27 finddepth(\&wanted, @directories_to_search);
31 find({ wanted => \&process, follow => 1 }, '.');
35 These are functions for searching through directory trees doing work
36 on each file found similar to the Unix I<find> command. File::Find
37 exports two functions, C<find> and C<finddepth>. They work similarly
38 but have subtle differences.
44 find(\&wanted, @directories);
45 find(\%options, @directories);
47 C<find()> does a depth-first search over the given C<@directories> in
48 the order they are given. For each file or directory found, it calls
49 the C<&wanted> subroutine. (See below for details on how to use the
50 C<&wanted> function). Additionally, for each directory found, it will
51 C<chdir()> into that directory and continue the search, invoking the
52 C<&wanted> function on each file or subdirectory in the directory.
56 finddepth(\&wanted, @directories);
57 finddepth(\%options, @directories);
59 C<finddepth()> works just like C<find()> except that is invokes the
60 C<&wanted> function for a directory I<after> invoking it for the
61 directory's contents. It does a postorder traversal instead of a
62 preorder traversal, working from the bottom of the directory tree up
63 where C<find()> works from the top of the tree down.
69 The first argument to C<find()> is either a code reference to your
70 C<&wanted> function, or a hash reference describing the operations
71 to be performed for each file. The
72 code reference is described in L<The wanted function> below.
74 Here are the possible keys for the hash:
80 The value should be a code reference. This code reference is
81 described in L<The wanted function> below.
85 Reports the name of a directory only AFTER all its entries
86 have been reported. Entry point C<finddepth()> is a shortcut for
87 specifying C<<{ bydepth => 1 }>> in the first argument of C<find()>.
91 The value should be a code reference. This code reference is used to
92 preprocess the current directory. The name of the currently processed
93 directory is in C<$File::Find::dir>. Your preprocessing function is
94 called after C<readdir()>, but before the loop that calls the C<wanted()>
95 function. It is called with a list of strings (actually file/directory
96 names) and is expected to return a list of strings. The code can be
97 used to sort the file/directory names alphabetically, numerically,
98 or to filter out directory entries based on their name alone. When
99 I<follow> or I<follow_fast> are in effect, C<preprocess> is a no-op.
103 The value should be a code reference. It is invoked just before leaving
104 the currently processed directory. It is called in void context with no
105 arguments. The name of the current directory is in C<$File::Find::dir>. This
106 hook is handy for summarizing a directory, such as calculating its disk
107 usage. When I<follow> or I<follow_fast> are in effect, C<postprocess> is a
112 Causes symbolic links to be followed. Since directory trees with symbolic
113 links (followed) may contain files more than once and may even have
114 cycles, a hash has to be built up with an entry for each file.
115 This might be expensive both in space and time for a large
116 directory tree. See I<follow_fast> and I<follow_skip> below.
117 If either I<follow> or I<follow_fast> is in effect:
123 It is guaranteed that an I<lstat> has been called before the user's
124 C<wanted()> function is called. This enables fast file checks involving S<_>.
125 Note that this guarantee no longer holds if I<follow> or I<follow_fast>
130 There is a variable C<$File::Find::fullname> which holds the absolute
131 pathname of the file with all symbolic links resolved. If the link is
132 a dangling symbolic link, then fullname will be set to C<undef>.
136 This is a no-op on Win32.
140 This is similar to I<follow> except that it may report some files more
141 than once. It does detect cycles, however. Since only symbolic links
142 have to be hashed, this is much cheaper both in space and time. If
143 processing a file more than once (by the user's C<wanted()> function)
144 is worse than just taking time, the option I<follow> should be used.
146 This is also a no-op on Win32.
150 C<follow_skip==1>, which is the default, causes all files which are
151 neither directories nor symbolic links to be ignored if they are about
152 to be processed a second time. If a directory or a symbolic link
153 are about to be processed a second time, File::Find dies.
155 C<follow_skip==0> causes File::Find to die if any file is about to be
156 processed a second time.
158 C<follow_skip==2> causes File::Find to ignore any duplicate files and
159 directories but to proceed normally otherwise.
161 =item C<dangling_symlinks>
163 If true and a code reference, will be called with the symbolic link
164 name and the directory it lives in as arguments. Otherwise, if true
165 and warnings are on, warning "symbolic_link_name is a dangling
166 symbolic link\n" will be issued. If false, the dangling symbolic link
167 will be silently ignored.
171 Does not C<chdir()> to each directory as it recurses. The C<wanted()>
172 function will need to be aware of this, of course. In this case,
173 C<$_> will be the same as C<$File::Find::name>.
177 If find is used in taint-mode (-T command line switch or if EUID != UID
178 or if EGID != GID) then internally directory names have to be untainted
179 before they can be chdir'ed to. Therefore they are checked against a regular
180 expression I<untaint_pattern>. Note that all names passed to the user's
181 I<wanted()> function are still tainted. If this option is used while
182 not in taint-mode, C<untaint> is a no-op.
184 =item C<untaint_pattern>
186 See above. This should be set using the C<qr> quoting operator.
187 The default is set to C<qr|^([-+@\w./]+)$|>.
188 Note that the parentheses are vital.
190 =item C<untaint_skip>
192 If set, a directory which fails the I<untaint_pattern> is skipped,
193 including all its sub-directories. The default is to 'die' in such a case.
197 =head2 The wanted function
199 The C<wanted()> function does whatever verifications you want on
200 each file and directory. Note that despite its name, the C<wanted()>
201 function is a generic callback function, and does B<not> tell
202 File::Find if a file is "wanted" or not. In fact, its return value
205 The wanted function takes no arguments but rather does its work
206 through a collection of variables.
210 =item C<$File::Find::dir> is the current directory name,
212 =item C<$_> is the current filename within that directory
214 =item C<$File::Find::name> is the complete pathname to the file.
218 The above variables have all been localized and may be changed without
219 effecting data outside of the wanted function.
221 For example, when examining the file F</some/path/foo.ext> you will have:
223 $File::Find::dir = /some/path/
225 $File::Find::name = /some/path/foo.ext
227 You are chdir()'d to C<$File::Find::dir> when the function is called,
228 unless C<no_chdir> was specified. Note that when changing to
229 directories is in effect the root directory (F</>) is a somewhat
230 special case inasmuch as the concatenation of C<$File::Find::dir>,
231 C<'/'> and C<$_> is not literally equal to C<$File::Find::name>. The
232 table below summarizes all variants:
234 $File::Find::name $File::Find::dir $_
236 no_chdir=>0 /etc / etc
244 When <follow> or <follow_fast> are in effect, there is
245 also a C<$File::Find::fullname>. The function may set
246 C<$File::Find::prune> to prune the tree unless C<bydepth> was
247 specified. Unless C<follow> or C<follow_fast> is specified, for
248 compatibility reasons (find.pl, find2perl) there are in addition the
249 following globals available: C<$File::Find::topdir>,
250 C<$File::Find::topdev>, C<$File::Find::topino>,
251 C<$File::Find::topmode> and C<$File::Find::topnlink>.
253 This library is useful for the C<find2perl> tool, which when fed,
255 find2perl / -name .nfs\* -mtime +7 \
256 -exec rm -f {} \; -o -fstype nfs -prune
258 produces something like:
262 (($dev, $ino, $mode, $nlink, $uid, $gid) = lstat($_)) &&
266 ($nlink || (($dev, $ino, $mode, $nlink, $uid, $gid) = lstat($_))) &&
268 ($File::Find::prune = 1);
271 Notice the C<_> in the above C<int(-M _)>: the C<_> is a magical
272 filehandle that caches the information from the preceding
273 C<stat()>, C<lstat()>, or filetest.
275 Here's another interesting wanted function. It will find all symbolic
276 links that don't resolve:
279 -l && !-e && print "bogus link: $File::Find::name\n";
282 See also the script C<pfind> on CPAN for a nice application of this
287 If you run your program with the C<-w> switch, or if you use the
288 C<warnings> pragma, File::Find will report warnings for several weird
289 situations. You can disable these warnings by putting the statement
291 no warnings 'File::Find';
293 in the appropriate scope. See L<perllexwarn> for more info about lexical
300 =item $dont_use_nlink
302 You can set the variable C<$File::Find::dont_use_nlink> to 1, if you want to
303 force File::Find to always stat directories. This was used for file systems
304 that do not have an C<nlink> count matching the number of sub-directories.
305 Examples are ISO-9660 (CD-ROM), AFS, HPFS (OS/2 file system), FAT (DOS file
306 system) and a couple of others.
308 You shouldn't need to set this variable, since File::Find should now detect
309 such file systems on-the-fly and switch itself to using stat. This works even
310 for parts of your file system, like a mounted CD-ROM.
312 If you do set C<$File::Find::dont_use_nlink> to 1, you will notice slow-downs.
316 Be aware that the option to follow symbolic links can be dangerous.
317 Depending on the structure of the directory tree (including symbolic
318 links to directories) you might traverse a given (physical) directory
319 more than once (only if C<follow_fast> is in effect).
320 Furthermore, deleting or changing files in a symbolically linked directory
321 might cause very unpleasant surprises, since you delete or change files
322 in an unknown directory.
332 Mac OS (Classic) users should note a few differences:
338 The path separator is ':', not '/', and the current directory is denoted
339 as ':', not '.'. You should be careful about specifying relative pathnames.
340 While a full path always begins with a volume name, a relative pathname
341 should always begin with a ':'. If specifying a volume name only, a
342 trailing ':' is required.
346 C<$File::Find::dir> is guaranteed to end with a ':'. If C<$_>
347 contains the name of a directory, that name may or may not end with a
348 ':'. Likewise, C<$File::Find::name>, which contains the complete
349 pathname to that directory, and C<$File::Find::fullname>, which holds
350 the absolute pathname of that directory with all symbolic links resolved,
351 may or may not end with a ':'.
355 The default C<untaint_pattern> (see above) on Mac OS is set to
356 C<qr|^(.+)$|>. Note that the parentheses are vital.
360 The invisible system file "Icon\015" is ignored. While this file may
361 appear in every directory, there are some more invisible system files
362 on every volume, which are all located at the volume root level (i.e.
363 "MacintoshHD:"). These system files are B<not> excluded automatically.
364 Your filter may use the following code to recognize invisible files or
365 directories (requires Mac::Files):
369 # invisible() -- returns 1 if file/directory is invisible,
370 # 0 if it's visible or undef if an error occurred
374 my ($fileCat, $fileInfo);
375 my $invisible_flag = 1 << 14;
377 if ( $fileCat = FSpGetCatInfo($file) ) {
378 if ($fileInfo = $fileCat->ioFlFndrInfo() ) {
379 return (($fileInfo->fdFlags & $invisible_flag) && 1);
385 Generally, invisible files are system files, unless an odd application
386 decides to use invisible files for its own purposes. To distinguish
387 such files from system files, you have to look at the B<type> and B<creator>
388 file attributes. The MacPerl built-in functions C<GetFileInfo(FILE)> and
389 C<SetFileInfo(CREATOR, TYPE, FILES)> offer access to these attributes
390 (see MacPerl.pm for details).
392 Files that appear on the desktop actually reside in an (hidden) directory
393 named "Desktop Folder" on the particular disk volume. Note that, although
394 all desktop files appear to be on the same "virtual" desktop, each disk
395 volume actually maintains its own "Desktop Folder" directory.
401 =head1 BUGS AND CAVEATS
403 Despite the name of the C<finddepth()> function, both C<find()> and
404 C<finddepth()> perform a depth-first search of the directory
409 File::Find used to produce incorrect results if called recursively.
410 During the development of perl 5.8 this bug was fixed.
411 The first fixed version of File::Find was 1.01.
415 our @ISA = qw(Exporter);
416 our @EXPORT = qw(find finddepth);
423 require File::Basename;
426 # Should ideally be my() not our() but local() currently
427 # refuses to operate on lexicals
430 our ($wanted_callback, $avoid_nlink, $bydepth, $no_chdir, $follow,
431 $follow_skip, $full_check, $untaint, $untaint_skip, $untaint_pat,
432 $pre_process, $post_process, $dangling_symlinks);
437 return substr($cdir,0,rindex($cdir,'/')) if $fn eq $File::Find::current_dir;
439 $cdir = substr($cdir,0,rindex($cdir,'/')+1);
443 my $abs_name= $cdir . $fn;
445 if (substr($fn,0,3) eq '../') {
446 1 while $abs_name =~ s!/[^/]*/\.\./!/!;
452 # return the absolute name of a directory or file
453 sub contract_name_Mac {
457 if ($fn =~ /^(:+)(.*)$/) { # valid pathname starting with a ':'
459 my $colon_count = length ($1);
460 if ($colon_count == 1) {
461 $abs_name = $cdir . $2;
465 # need to move up the tree, but
466 # only if it's not a volume name
467 for (my $i=1; $i<$colon_count; $i++) {
468 unless ($cdir =~ /^[^:]+:$/) { # volume name
469 $cdir =~ s/[^:]+:$//;
475 $abs_name = $cdir . $2;
482 # $fn may be a valid path to a directory or file or (dangling)
483 # symlink, without a leading ':'
484 if ( (-e $fn) || (-l $fn) ) {
485 if ($fn =~ /^[^:]+:/) { # a volume name like DataHD:*
486 return $fn; # $fn is already an absolute path
489 $abs_name = $cdir . $fn;
493 else { # argh!, $fn is not a valid directory/file
499 sub PathCombine($$) {
500 my ($Base,$Name) = @_;
504 # $Name is the resolved symlink (always a full path on MacOS),
505 # i.e. there's no need to call contract_name_Mac()
508 # (simple) check for recursion
509 if ( ( $Base =~ /^$AbsName/) && (-d $AbsName) ) { # recursion
514 if (substr($Name,0,1) eq '/') {
518 $AbsName= contract_name($Base,$Name);
521 # (simple) check for recursion
522 my $newlen= length($AbsName);
523 if ($newlen <= length($Base)) {
524 if (($newlen == length($Base) || substr($Base,$newlen,1) eq '/')
525 && $AbsName eq substr($Base,0,$newlen))
534 sub Follow_SymLink($) {
537 my ($NewName,$DEV, $INO);
538 ($DEV, $INO)= lstat $AbsName;
541 if ($SLnkSeen{$DEV, $INO}++) {
542 if ($follow_skip < 2) {
543 die "$AbsName is encountered a second time";
549 $NewName= PathCombine($AbsName, readlink($AbsName));
550 unless(defined $NewName) {
551 if ($follow_skip < 2) {
552 die "$AbsName is a recursive symbolic link";
561 ($DEV, $INO) = lstat($AbsName);
562 return undef unless defined $DEV; # dangling symbolic link
565 if ($full_check && defined $DEV && $SLnkSeen{$DEV, $INO}++) {
566 if ( ($follow_skip < 1) || ((-d _) && ($follow_skip < 2)) ) {
567 die "$AbsName encountered a second time";
577 our($dir, $name, $fullname, $prune);
578 sub _find_dir_symlnk($$$);
581 # check whether or not a scalar variable is tainted
582 # (code straight from the Camel, 3rd ed., page 561)
585 my $nada = substr($arg, 0, 0); # zero-length
587 eval { eval "# $nada" };
588 return length($@) != 0;
593 die "invalid top directory" unless defined $_[0];
595 # This function must local()ize everything because callbacks may
596 # call find() or finddepth()
599 local ($wanted_callback, $avoid_nlink, $bydepth, $no_chdir, $follow,
600 $follow_skip, $full_check, $untaint, $untaint_skip, $untaint_pat,
601 $pre_process, $post_process, $dangling_symlinks);
602 local($dir, $name, $fullname, $prune);
605 my $cwd = $wanted->{bydepth} ? Cwd::fastcwd() : Cwd::getcwd();
606 my $cwd_untainted = $cwd;
608 $wanted_callback = $wanted->{wanted};
609 $bydepth = $wanted->{bydepth};
610 $pre_process = $wanted->{preprocess};
611 $post_process = $wanted->{postprocess};
612 $no_chdir = $wanted->{no_chdir};
613 $full_check = $^O eq 'MSWin32' ? 0 : $wanted->{follow};
614 $follow = $^O eq 'MSWin32' ? 0 :
615 $full_check || $wanted->{follow_fast};
616 $follow_skip = $wanted->{follow_skip};
617 $untaint = $wanted->{untaint};
618 $untaint_pat = $wanted->{untaint_pattern};
619 $untaint_skip = $wanted->{untaint_skip};
620 $dangling_symlinks = $wanted->{dangling_symlinks};
622 # for compatibility reasons (find.pl, find2perl)
623 local our ($topdir, $topdev, $topino, $topmode, $topnlink);
625 # a symbolic link to a directory doesn't increase the link count
626 $avoid_nlink = $follow || $File::Find::dont_use_nlink;
628 my ($abs_dir, $Is_Dir);
631 foreach my $TOP (@_) {
634 ($topdev,$topino,$topmode,$topnlink) = $follow ? stat $top_item : lstat $top_item;
637 $top_item = ":$top_item"
638 if ( (-d _) && ( $top_item !~ /:/ ) );
639 } elsif ($^O eq 'MSWin32') {
640 $top_item =~ s|/\z|| unless $top_item =~ m|\w:/$|;
643 $top_item =~ s|/\z|| unless $top_item eq '/';
651 $cwd = "$cwd:" unless ($cwd =~ /:$/); # for safety
653 if ($top_item eq $File::Find::current_dir) {
657 $abs_dir = contract_name_Mac($cwd, $top_item);
658 unless (defined $abs_dir) {
659 warnings::warnif "Can't determine absolute path for $top_item (No such file or directory)\n";
666 if (substr($top_item,0,1) eq '/') {
667 $abs_dir = $top_item;
669 elsif ($top_item eq $File::Find::current_dir) {
672 else { # care about any ../
673 $abs_dir = contract_name("$cwd/",$top_item);
676 $abs_dir= Follow_SymLink($abs_dir);
677 unless (defined $abs_dir) {
678 if ($dangling_symlinks) {
679 if (ref $dangling_symlinks eq 'CODE') {
680 $dangling_symlinks->($top_item, $cwd);
682 warnings::warnif "$top_item is a dangling symbolic link\n";
689 _find_dir_symlnk($wanted, $abs_dir, $top_item);
695 unless (defined $topnlink) {
696 warnings::warnif "Can't stat $top_item: $!\n";
700 $top_item =~ s/\.dir\z//i if $Is_VMS;
701 _find_dir($wanted, $top_item, $topnlink);
710 unless (($_,$dir) = File::Basename::fileparse($abs_dir)) {
712 ($dir,$_) = (':', $top_item); # $File::Find::dir, $_
715 ($dir,$_) = ('./', $top_item);
720 if (( $untaint ) && (is_tainted($dir) )) {
721 ( $abs_dir ) = $dir =~ m|$untaint_pat|;
722 unless (defined $abs_dir) {
723 if ($untaint_skip == 0) {
724 die "directory $dir is still tainted";
732 unless ($no_chdir || chdir $abs_dir) {
733 warnings::warnif "Couldn't chdir $abs_dir: $!\n";
737 $name = $abs_dir . $_; # $File::Find::name
738 $_ = $name if $no_chdir;
740 { $wanted_callback->() }; # protect against wild "next"
744 unless ( $no_chdir ) {
745 if ( ($check_t_cwd) && (($untaint) && (is_tainted($cwd) )) ) {
746 ( $cwd_untainted ) = $cwd =~ m|$untaint_pat|;
747 unless (defined $cwd_untainted) {
748 die "insecure cwd in find(depth)";
752 unless (chdir $cwd_untainted) {
753 die "Can't cd to $cwd: $!\n";
761 # $p_dir : "parent directory"
762 # $nlink : what came back from the stat
764 # chdir (if not no_chdir) to dir
767 my ($wanted, $p_dir, $nlink) = @_;
768 my ($CdLvl,$Level) = (0,0);
771 my ($subcount,$sub_nlink);
773 my $dir_name= $p_dir;
775 my $dir_rel = $File::Find::current_dir;
780 $dir_pref= ($p_dir =~ /:$/) ? $p_dir : "$p_dir:"; # preface
781 } elsif ($^O eq 'MSWin32') {
782 $dir_pref = ($p_dir =~ m|\w:/$| ? $p_dir : "$p_dir/" );
785 $dir_pref= ( $p_dir eq '/' ? '/' : "$p_dir/" );
788 local ($dir, $name, $prune, *DIR);
790 unless ( $no_chdir || ($p_dir eq $File::Find::current_dir)) {
792 if (( $untaint ) && (is_tainted($p_dir) )) {
793 ( $udir ) = $p_dir =~ m|$untaint_pat|;
794 unless (defined $udir) {
795 if ($untaint_skip == 0) {
796 die "directory $p_dir is still tainted";
803 unless (chdir ($Is_VMS && $udir !~ /[\/\[<]+/ ? "./$udir" : $udir)) {
804 warnings::warnif "Can't cd to $udir: $!\n";
809 # push the starting directory
810 push @Stack,[$CdLvl,$p_dir,$dir_rel,-1] if $bydepth;
813 $p_dir = $dir_pref; # ensure trailing ':'
816 while (defined $SE) {
818 $dir= $p_dir; # $File::Find::dir
819 $name= $dir_name; # $File::Find::name
820 $_= ($no_chdir ? $dir_name : $dir_rel ); # $_
821 # prune may happen here
823 { $wanted_callback->() }; # protect against wild "next"
827 # change to that directory
828 unless ($no_chdir || ($dir_rel eq $File::Find::current_dir)) {
830 if ( ($untaint) && (($tainted) || ($tainted = is_tainted($dir_rel) )) ) {
831 ( $udir ) = $dir_rel =~ m|$untaint_pat|;
832 unless (defined $udir) {
833 if ($untaint_skip == 0) {
835 die "directory ($p_dir) $dir_rel is still tainted";
838 die "directory (" . ($p_dir ne '/' ? $p_dir : '') . "/) $dir_rel is still tainted";
840 } else { # $untaint_skip == 1
845 unless (chdir ($Is_VMS && $udir !~ /[\/\[<]+/ ? "./$udir" : $udir)) {
847 warnings::warnif "Can't cd to ($p_dir) $udir: $!\n";
850 warnings::warnif "Can't cd to (" .
851 ($p_dir ne '/' ? $p_dir : '') . "/) $udir: $!\n";
859 $dir_name = "$dir_name:" unless ($dir_name =~ /:$/);
862 $dir= $dir_name; # $File::Find::dir
864 # Get the list of files in the current directory.
865 unless (opendir DIR, ($no_chdir ? $dir_name : $File::Find::current_dir)) {
866 warnings::warnif "Can't opendir($dir_name): $!\n";
869 @filenames = readdir DIR;
871 @filenames = $pre_process->(@filenames) if $pre_process;
872 push @Stack,[$CdLvl,$dir_name,"",-2] if $post_process;
874 # default: use whatever was specifid
875 # (if $nlink >= 2, and $avoid_nlink == 0, this will switch back)
876 $no_nlink = $avoid_nlink;
877 # if dir has wrong nlink count, force switch to slower stat method
878 $no_nlink = 1 if ($nlink < 2);
880 if ($nlink == 2 && !$no_nlink) {
881 # This dir has no subdirectories.
882 for my $FN (@filenames) {
883 next if $FN =~ $File::Find::skip_pattern;
885 $name = $dir_pref . $FN; # $File::Find::name
886 $_ = ($no_chdir ? $name : $FN); # $_
887 { $wanted_callback->() }; # protect against wild "next"
892 # This dir has subdirectories.
893 $subcount = $nlink - 2;
895 # HACK: insert directories at this position. so as to preserve
896 # the user pre-processed ordering of files.
897 # EG: directory traversal is in user sorted order, not at random.
898 my $stack_top = @Stack;
900 for my $FN (@filenames) {
901 next if $FN =~ $File::Find::skip_pattern;
902 if ($subcount > 0 || $no_nlink) {
903 # Seen all the subdirs?
904 # check for directoriness.
905 # stat is faster for a file in the current directory
906 $sub_nlink = (lstat ($no_chdir ? $dir_pref . $FN : $FN))[3];
910 $FN =~ s/\.dir\z//i if $Is_VMS;
911 # HACK: replace push to preserve dir traversal order
912 #push @Stack,[$CdLvl,$dir_name,$FN,$sub_nlink];
913 splice @Stack, $stack_top, 0,
914 [$CdLvl,$dir_name,$FN,$sub_nlink];
917 $name = $dir_pref . $FN; # $File::Find::name
918 $_= ($no_chdir ? $name : $FN); # $_
919 { $wanted_callback->() }; # protect against wild "next"
923 $name = $dir_pref . $FN; # $File::Find::name
924 $_= ($no_chdir ? $name : $FN); # $_
925 { $wanted_callback->() }; # protect against wild "next"
931 while ( defined ($SE = pop @Stack) ) {
932 ($Level, $p_dir, $dir_rel, $nlink) = @$SE;
933 if ($CdLvl > $Level && !$no_chdir) {
936 $tmp = (':' x ($CdLvl-$Level)) . ':';
939 $tmp = join('/',('..') x ($CdLvl-$Level));
941 die "Can't cd to $dir_name" . $tmp
947 # $pdir always has a trailing ':', except for the starting dir,
948 # where $dir_rel eq ':'
949 $dir_name = "$p_dir$dir_rel";
950 $dir_pref = "$dir_name:";
952 elsif ($^O eq 'MSWin32') {
953 $dir_name = ($p_dir =~ m|\w:/$| ? "$p_dir$dir_rel" : "$p_dir/$dir_rel");
954 $dir_pref = "$dir_name/";
957 $dir_name = ($p_dir eq '/' ? "/$dir_rel" : "$p_dir/$dir_rel");
958 $dir_pref = "$dir_name/";
961 if ( $nlink == -2 ) {
962 $name = $dir = $p_dir; # $File::Find::name / dir
963 $_ = $File::Find::current_dir;
964 $post_process->(); # End-of-directory processing
966 elsif ( $nlink < 0 ) { # must be finddepth, report dirname now
969 if ($dir_rel eq ':') { # must be the top dir, where we started
970 $name =~ s|:$||; # $File::Find::name
971 $p_dir = "$p_dir:" unless ($p_dir =~ /:$/);
973 $dir = $p_dir; # $File::Find::dir
974 $_ = ($no_chdir ? $name : $dir_rel); # $_
977 if ( substr($name,-2) eq '/.' ) {
978 substr($name, length($name) == 2 ? -1 : -2) = '';
981 $_ = ($no_chdir ? $dir_name : $dir_rel );
982 if ( substr($_,-2) eq '/.' ) {
983 substr($_, length($_) == 2 ? -1 : -2) = '';
986 { $wanted_callback->() }; # protect against wild "next"
989 push @Stack,[$CdLvl,$p_dir,$dir_rel,-1] if $bydepth;
999 # $dir_loc : absolute location of a dir
1000 # $p_dir : "parent directory"
1002 # chdir (if not no_chdir) to dir
1004 sub _find_dir_symlnk($$$) {
1005 my ($wanted, $dir_loc, $p_dir) = @_; # $dir_loc is the absolute directory
1009 my $updir_loc = $dir_loc; # untainted parent directory
1011 my $dir_name = $p_dir;
1014 my $dir_rel = $File::Find::current_dir;
1015 my $byd_flag; # flag for pending stack entry if $bydepth
1020 $dir_pref = ($p_dir =~ /:$/) ? "$p_dir" : "$p_dir:";
1021 $loc_pref = ($dir_loc =~ /:$/) ? "$dir_loc" : "$dir_loc:";
1023 $dir_pref = ( $p_dir eq '/' ? '/' : "$p_dir/" );
1024 $loc_pref = ( $dir_loc eq '/' ? '/' : "$dir_loc/" );
1027 local ($dir, $name, $fullname, $prune, *DIR);
1029 unless ($no_chdir) {
1030 # untaint the topdir
1031 if (( $untaint ) && (is_tainted($dir_loc) )) {
1032 ( $updir_loc ) = $dir_loc =~ m|$untaint_pat|; # parent dir, now untainted
1033 # once untainted, $updir_loc is pushed on the stack (as parent directory);
1034 # hence, we don't need to untaint the parent directory every time we chdir
1036 unless (defined $updir_loc) {
1037 if ($untaint_skip == 0) {
1038 die "directory $dir_loc is still tainted";
1045 $ok = chdir($updir_loc) unless ($p_dir eq $File::Find::current_dir);
1047 warnings::warnif "Can't cd to $updir_loc: $!\n";
1052 push @Stack,[$dir_loc,$updir_loc,$p_dir,$dir_rel,-1] if $bydepth;
1055 $p_dir = $dir_pref; # ensure trailing ':'
1058 while (defined $SE) {
1061 # change (back) to parent directory (always untainted)
1062 unless ($no_chdir) {
1063 unless (chdir $updir_loc) {
1064 warnings::warnif "Can't cd to $updir_loc: $!\n";
1068 $dir= $p_dir; # $File::Find::dir
1069 $name= $dir_name; # $File::Find::name
1070 $_= ($no_chdir ? $dir_name : $dir_rel ); # $_
1071 $fullname= $dir_loc; # $File::Find::fullname
1072 # prune may happen here
1074 lstat($_); # make sure file tests with '_' work
1075 { $wanted_callback->() }; # protect against wild "next"
1079 # change to that directory
1080 unless ($no_chdir || ($dir_rel eq $File::Find::current_dir)) {
1081 $updir_loc = $dir_loc;
1082 if ( ($untaint) && (($tainted) || ($tainted = is_tainted($dir_loc) )) ) {
1083 # untaint $dir_loc, what will be pushed on the stack as (untainted) parent dir
1084 ( $updir_loc ) = $dir_loc =~ m|$untaint_pat|;
1085 unless (defined $updir_loc) {
1086 if ($untaint_skip == 0) {
1087 die "directory $dir_loc is still tainted";
1094 unless (chdir $updir_loc) {
1095 warnings::warnif "Can't cd to $updir_loc: $!\n";
1101 $dir_name = "$dir_name:" unless ($dir_name =~ /:$/);
1104 $dir = $dir_name; # $File::Find::dir
1106 # Get the list of files in the current directory.
1107 unless (opendir DIR, ($no_chdir ? $dir_loc : $File::Find::current_dir)) {
1108 warnings::warnif "Can't opendir($dir_loc): $!\n";
1111 @filenames = readdir DIR;
1114 for my $FN (@filenames) {
1115 next if $FN =~ $File::Find::skip_pattern;
1117 # follow symbolic links / do an lstat
1118 $new_loc = Follow_SymLink($loc_pref.$FN);
1120 # ignore if invalid symlink
1121 unless (defined $new_loc) {
1122 if ($dangling_symlinks) {
1123 if (ref $dangling_symlinks eq 'CODE') {
1124 $dangling_symlinks->($FN, $dir_pref);
1126 warnings::warnif "$dir_pref$FN is a dangling symbolic link\n";
1131 $name = $dir_pref . $FN;
1132 $_ = ($no_chdir ? $name : $FN);
1133 { $wanted_callback->() };
1138 push @Stack,[$new_loc,$updir_loc,$dir_name,$FN,1];
1141 $fullname = $new_loc; # $File::Find::fullname
1142 $name = $dir_pref . $FN; # $File::Find::name
1143 $_ = ($no_chdir ? $name : $FN); # $_
1144 { $wanted_callback->() }; # protect against wild "next"
1150 while (defined($SE = pop @Stack)) {
1151 ($dir_loc, $updir_loc, $p_dir, $dir_rel, $byd_flag) = @$SE;
1153 # $p_dir always has a trailing ':', except for the starting dir,
1154 # where $dir_rel eq ':'
1155 $dir_name = "$p_dir$dir_rel";
1156 $dir_pref = "$dir_name:";
1157 $loc_pref = ($dir_loc =~ /:$/) ? $dir_loc : "$dir_loc:";
1160 $dir_name = ($p_dir eq '/' ? "/$dir_rel" : "$p_dir/$dir_rel");
1161 $dir_pref = "$dir_name/";
1162 $loc_pref = "$dir_loc/";
1164 if ( $byd_flag < 0 ) { # must be finddepth, report dirname now
1165 unless ($no_chdir || ($dir_rel eq $File::Find::current_dir)) {
1166 unless (chdir $updir_loc) { # $updir_loc (parent dir) is always untainted
1167 warnings::warnif "Can't cd to $updir_loc: $!\n";
1171 $fullname = $dir_loc; # $File::Find::fullname
1172 $name = $dir_name; # $File::Find::name
1174 if ($dir_rel eq ':') { # must be the top dir, where we started
1175 $name =~ s|:$||; # $File::Find::name
1176 $p_dir = "$p_dir:" unless ($p_dir =~ /:$/);
1178 $dir = $p_dir; # $File::Find::dir
1179 $_ = ($no_chdir ? $name : $dir_rel); # $_
1182 if ( substr($name,-2) eq '/.' ) {
1183 substr($name, length($name) == 2 ? -1 : -2) = ''; # $File::Find::name
1185 $dir = $p_dir; # $File::Find::dir
1186 $_ = ($no_chdir ? $dir_name : $dir_rel); # $_
1187 if ( substr($_,-2) eq '/.' ) {
1188 substr($_, length($_) == 2 ? -1 : -2) = '';
1192 lstat($_); # make sure file tests with '_' work
1193 { $wanted_callback->() }; # protect against wild "next"
1196 push @Stack,[$dir_loc, $updir_loc, $p_dir, $dir_rel,-1] if $bydepth;
1206 if ( ref($wanted) eq 'HASH' ) {
1207 if ( $wanted->{follow} || $wanted->{follow_fast}) {
1208 $wanted->{follow_skip} = 1 unless defined $wanted->{follow_skip};
1210 if ( $wanted->{untaint} ) {
1211 $wanted->{untaint_pattern} = $File::Find::untaint_pattern
1212 unless defined $wanted->{untaint_pattern};
1213 $wanted->{untaint_skip} = 0 unless defined $wanted->{untaint_skip};
1218 return { wanted => $wanted };
1224 _find_opt(wrap_wanted($wanted), @_);
1228 my $wanted = wrap_wanted(shift);
1229 $wanted->{bydepth} = 1;
1230 _find_opt($wanted, @_);
1234 $File::Find::skip_pattern = qr/^\.{1,2}\z/;
1235 $File::Find::untaint_pattern = qr|^([-+@\w./]+)$|;
1237 # These are hard-coded for now, but may move to hint files.
1240 $File::Find::dont_use_nlink = 1;
1242 elsif ($^O eq 'MacOS') {
1244 $File::Find::dont_use_nlink = 1;
1245 $File::Find::skip_pattern = qr/^Icon\015\z/;
1246 $File::Find::untaint_pattern = qr|^(.+)$|;
1249 # this _should_ work properly on all platforms
1250 # where File::Find can be expected to work
1251 $File::Find::current_dir = File::Spec->curdir || '.';
1253 $File::Find::dont_use_nlink = 1
1254 if $^O eq 'os2' || $^O eq 'dos' || $^O eq 'amigaos' || $^O eq 'MSWin32' ||
1255 $^O eq 'interix' || $^O eq 'cygwin' || $^O eq 'epoc' || $^O eq 'qnx' ||
1258 # Set dont_use_nlink in your hint file if your system's stat doesn't
1259 # report the number of links in a directory as an indication
1260 # of the number of files.
1261 # See, e.g. hints/machten.sh for MachTen 2.2.
1262 unless ($File::Find::dont_use_nlink) {
1264 $File::Find::dont_use_nlink = 1 if ($Config::Config{'dont_use_nlink'});
1267 # We need a function that checks if a scalar is tainted. Either use the
1268 # Scalar::Util module's tainted() function or our (slower) pure Perl
1269 # fallback is_tainted_pp()
1272 eval { require Scalar::Util };
1273 *is_tainted = $@ ? \&is_tainted_pp : \&Scalar::Util::tainted;