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 it 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. The C<&wanted> subroutine is
86 Reports the name of a directory only AFTER all its entries
87 have been reported. Entry point C<finddepth()> is a shortcut for
88 specifying C<< { bydepth => 1 } >> in the first argument of C<find()>.
92 The value should be a code reference. This code reference is used to
93 preprocess the current directory. The name of the currently processed
94 directory is in C<$File::Find::dir>. Your preprocessing function is
95 called after C<readdir()>, but before the loop that calls the C<wanted()>
96 function. It is called with a list of strings (actually file/directory
97 names) and is expected to return a list of strings. The code can be
98 used to sort the file/directory names alphabetically, numerically,
99 or to filter out directory entries based on their name alone. When
100 I<follow> or I<follow_fast> are in effect, C<preprocess> is a no-op.
104 The value should be a code reference. It is invoked just before leaving
105 the currently processed directory. It is called in void context with no
106 arguments. The name of the current directory is in C<$File::Find::dir>. This
107 hook is handy for summarizing a directory, such as calculating its disk
108 usage. When I<follow> or I<follow_fast> are in effect, C<postprocess> is a
113 Causes symbolic links to be followed. Since directory trees with symbolic
114 links (followed) may contain files more than once and may even have
115 cycles, a hash has to be built up with an entry for each file.
116 This might be expensive both in space and time for a large
117 directory tree. See I<follow_fast> and I<follow_skip> below.
118 If either I<follow> or I<follow_fast> is in effect:
124 It is guaranteed that an I<lstat> has been called before the user's
125 C<wanted()> function is called. This enables fast file checks involving S<_>.
126 Note that this guarantee no longer holds if I<follow> or I<follow_fast>
131 There is a variable C<$File::Find::fullname> which holds the absolute
132 pathname of the file with all symbolic links resolved. If the link is
133 a dangling symbolic link, then fullname will be set to C<undef>.
137 This is a no-op on Win32.
141 This is similar to I<follow> except that it may report some files more
142 than once. It does detect cycles, however. Since only symbolic links
143 have to be hashed, this is much cheaper both in space and time. If
144 processing a file more than once (by the user's C<wanted()> function)
145 is worse than just taking time, the option I<follow> should be used.
147 This is also a no-op on Win32.
151 C<follow_skip==1>, which is the default, causes all files which are
152 neither directories nor symbolic links to be ignored if they are about
153 to be processed a second time. If a directory or a symbolic link
154 are about to be processed a second time, File::Find dies.
156 C<follow_skip==0> causes File::Find to die if any file is about to be
157 processed a second time.
159 C<follow_skip==2> causes File::Find to ignore any duplicate files and
160 directories but to proceed normally otherwise.
162 =item C<dangling_symlinks>
164 If true and a code reference, will be called with the symbolic link
165 name and the directory it lives in as arguments. Otherwise, if true
166 and warnings are on, warning "symbolic_link_name is a dangling
167 symbolic link\n" will be issued. If false, the dangling symbolic link
168 will be silently ignored.
172 Does not C<chdir()> to each directory as it recurses. The C<wanted()>
173 function will need to be aware of this, of course. In this case,
174 C<$_> will be the same as C<$File::Find::name>.
178 If find is used in taint-mode (-T command line switch or if EUID != UID
179 or if EGID != GID) then internally directory names have to be untainted
180 before they can be chdir'ed to. Therefore they are checked against a regular
181 expression I<untaint_pattern>. Note that all names passed to the user's
182 I<wanted()> function are still tainted. If this option is used while
183 not in taint-mode, C<untaint> is a no-op.
185 =item C<untaint_pattern>
187 See above. This should be set using the C<qr> quoting operator.
188 The default is set to C<qr|^([-+@\w./]+)$|>.
189 Note that the parentheses are vital.
191 =item C<untaint_skip>
193 If set, a directory which fails the I<untaint_pattern> is skipped,
194 including all its sub-directories. The default is to 'die' in such a case.
198 =head2 The wanted function
200 The C<wanted()> function does whatever verifications you want on
201 each file and directory. Note that despite its name, the C<wanted()>
202 function is a generic callback function, and does B<not> tell
203 File::Find if a file is "wanted" or not. In fact, its return value
206 The wanted function takes no arguments but rather does its work
207 through a collection of variables.
211 =item C<$File::Find::dir> is the current directory name,
213 =item C<$_> is the current filename within that directory
215 =item C<$File::Find::name> is the complete pathname to the file.
219 The above variables have all been localized and may be changed without
220 effecting data outside of the wanted function.
222 For example, when examining the file F</some/path/foo.ext> you will have:
224 $File::Find::dir = /some/path/
226 $File::Find::name = /some/path/foo.ext
228 You are chdir()'d to C<$File::Find::dir> when the function is called,
229 unless C<no_chdir> was specified. Note that when changing to
230 directories is in effect the root directory (F</>) is a somewhat
231 special case inasmuch as the concatenation of C<$File::Find::dir>,
232 C<'/'> and C<$_> is not literally equal to C<$File::Find::name>. The
233 table below summarizes all variants:
235 $File::Find::name $File::Find::dir $_
237 no_chdir=>0 /etc / etc
245 When C<follow> or C<follow_fast> are in effect, there is
246 also a C<$File::Find::fullname>. The function may set
247 C<$File::Find::prune> to prune the tree unless C<bydepth> was
248 specified. Unless C<follow> or C<follow_fast> is specified, for
249 compatibility reasons (find.pl, find2perl) there are in addition the
250 following globals available: C<$File::Find::topdir>,
251 C<$File::Find::topdev>, C<$File::Find::topino>,
252 C<$File::Find::topmode> and C<$File::Find::topnlink>.
254 This library is useful for the C<find2perl> tool, which when fed,
256 find2perl / -name .nfs\* -mtime +7 \
257 -exec rm -f {} \; -o -fstype nfs -prune
259 produces something like:
263 (($dev, $ino, $mode, $nlink, $uid, $gid) = lstat($_)) &&
267 ($nlink || (($dev, $ino, $mode, $nlink, $uid, $gid) = lstat($_))) &&
269 ($File::Find::prune = 1);
272 Notice the C<_> in the above C<int(-M _)>: the C<_> is a magical
273 filehandle that caches the information from the preceding
274 C<stat()>, C<lstat()>, or filetest.
276 Here's another interesting wanted function. It will find all symbolic
277 links that don't resolve:
280 -l && !-e && print "bogus link: $File::Find::name\n";
283 See also the script C<pfind> on CPAN for a nice application of this
288 If you run your program with the C<-w> switch, or if you use the
289 C<warnings> pragma, File::Find will report warnings for several weird
290 situations. You can disable these warnings by putting the statement
292 no warnings 'File::Find';
294 in the appropriate scope. See L<perllexwarn> for more info about lexical
301 =item $dont_use_nlink
303 You can set the variable C<$File::Find::dont_use_nlink> to 1, if you want to
304 force File::Find to always stat directories. This was used for file systems
305 that do not have an C<nlink> count matching the number of sub-directories.
306 Examples are ISO-9660 (CD-ROM), AFS, HPFS (OS/2 file system), FAT (DOS file
307 system) and a couple of others.
309 You shouldn't need to set this variable, since File::Find should now detect
310 such file systems on-the-fly and switch itself to using stat. This works even
311 for parts of your file system, like a mounted CD-ROM.
313 If you do set C<$File::Find::dont_use_nlink> to 1, you will notice slow-downs.
317 Be aware that the option to follow symbolic links can be dangerous.
318 Depending on the structure of the directory tree (including symbolic
319 links to directories) you might traverse a given (physical) directory
320 more than once (only if C<follow_fast> is in effect).
321 Furthermore, deleting or changing files in a symbolically linked directory
322 might cause very unpleasant surprises, since you delete or change files
323 in an unknown directory.
333 Mac OS (Classic) users should note a few differences:
339 The path separator is ':', not '/', and the current directory is denoted
340 as ':', not '.'. You should be careful about specifying relative pathnames.
341 While a full path always begins with a volume name, a relative pathname
342 should always begin with a ':'. If specifying a volume name only, a
343 trailing ':' is required.
347 C<$File::Find::dir> is guaranteed to end with a ':'. If C<$_>
348 contains the name of a directory, that name may or may not end with a
349 ':'. Likewise, C<$File::Find::name>, which contains the complete
350 pathname to that directory, and C<$File::Find::fullname>, which holds
351 the absolute pathname of that directory with all symbolic links resolved,
352 may or may not end with a ':'.
356 The default C<untaint_pattern> (see above) on Mac OS is set to
357 C<qr|^(.+)$|>. Note that the parentheses are vital.
361 The invisible system file "Icon\015" is ignored. While this file may
362 appear in every directory, there are some more invisible system files
363 on every volume, which are all located at the volume root level (i.e.
364 "MacintoshHD:"). These system files are B<not> excluded automatically.
365 Your filter may use the following code to recognize invisible files or
366 directories (requires Mac::Files):
370 # invisible() -- returns 1 if file/directory is invisible,
371 # 0 if it's visible or undef if an error occurred
375 my ($fileCat, $fileInfo);
376 my $invisible_flag = 1 << 14;
378 if ( $fileCat = FSpGetCatInfo($file) ) {
379 if ($fileInfo = $fileCat->ioFlFndrInfo() ) {
380 return (($fileInfo->fdFlags & $invisible_flag) && 1);
386 Generally, invisible files are system files, unless an odd application
387 decides to use invisible files for its own purposes. To distinguish
388 such files from system files, you have to look at the B<type> and B<creator>
389 file attributes. The MacPerl built-in functions C<GetFileInfo(FILE)> and
390 C<SetFileInfo(CREATOR, TYPE, FILES)> offer access to these attributes
391 (see MacPerl.pm for details).
393 Files that appear on the desktop actually reside in an (hidden) directory
394 named "Desktop Folder" on the particular disk volume. Note that, although
395 all desktop files appear to be on the same "virtual" desktop, each disk
396 volume actually maintains its own "Desktop Folder" directory.
402 =head1 BUGS AND CAVEATS
404 Despite the name of the C<finddepth()> function, both C<find()> and
405 C<finddepth()> perform a depth-first search of the directory
410 File::Find used to produce incorrect results if called recursively.
411 During the development of perl 5.8 this bug was fixed.
412 The first fixed version of File::Find was 1.01.
416 our @ISA = qw(Exporter);
417 our @EXPORT = qw(find finddepth);
424 require File::Basename;
427 # Should ideally be my() not our() but local() currently
428 # refuses to operate on lexicals
431 our ($wanted_callback, $avoid_nlink, $bydepth, $no_chdir, $follow,
432 $follow_skip, $full_check, $untaint, $untaint_skip, $untaint_pat,
433 $pre_process, $post_process, $dangling_symlinks);
438 return substr($cdir,0,rindex($cdir,'/')) if $fn eq $File::Find::current_dir;
440 $cdir = substr($cdir,0,rindex($cdir,'/')+1);
444 my $abs_name= $cdir . $fn;
446 if (substr($fn,0,3) eq '../') {
447 1 while $abs_name =~ s!/[^/]*/\.\./!/!;
453 # return the absolute name of a directory or file
454 sub contract_name_Mac {
458 if ($fn =~ /^(:+)(.*)$/) { # valid pathname starting with a ':'
460 my $colon_count = length ($1);
461 if ($colon_count == 1) {
462 $abs_name = $cdir . $2;
466 # need to move up the tree, but
467 # only if it's not a volume name
468 for (my $i=1; $i<$colon_count; $i++) {
469 unless ($cdir =~ /^[^:]+:$/) { # volume name
470 $cdir =~ s/[^:]+:$//;
476 $abs_name = $cdir . $2;
483 # $fn may be a valid path to a directory or file or (dangling)
484 # symlink, without a leading ':'
485 if ( (-e $fn) || (-l $fn) ) {
486 if ($fn =~ /^[^:]+:/) { # a volume name like DataHD:*
487 return $fn; # $fn is already an absolute path
490 $abs_name = $cdir . $fn;
494 else { # argh!, $fn is not a valid directory/file
500 sub PathCombine($$) {
501 my ($Base,$Name) = @_;
505 # $Name is the resolved symlink (always a full path on MacOS),
506 # i.e. there's no need to call contract_name_Mac()
509 # (simple) check for recursion
510 if ( ( $Base =~ /^$AbsName/) && (-d $AbsName) ) { # recursion
515 if (substr($Name,0,1) eq '/') {
519 $AbsName= contract_name($Base,$Name);
522 # (simple) check for recursion
523 my $newlen= length($AbsName);
524 if ($newlen <= length($Base)) {
525 if (($newlen == length($Base) || substr($Base,$newlen,1) eq '/')
526 && $AbsName eq substr($Base,0,$newlen))
535 sub Follow_SymLink($) {
538 my ($NewName,$DEV, $INO);
539 ($DEV, $INO)= lstat $AbsName;
542 if ($SLnkSeen{$DEV, $INO}++) {
543 if ($follow_skip < 2) {
544 die "$AbsName is encountered a second time";
550 $NewName= PathCombine($AbsName, readlink($AbsName));
551 unless(defined $NewName) {
552 if ($follow_skip < 2) {
553 die "$AbsName is a recursive symbolic link";
562 ($DEV, $INO) = lstat($AbsName);
563 return undef unless defined $DEV; # dangling symbolic link
566 if ($full_check && defined $DEV && $SLnkSeen{$DEV, $INO}++) {
567 if ( ($follow_skip < 1) || ((-d _) && ($follow_skip < 2)) ) {
568 die "$AbsName encountered a second time";
578 our($dir, $name, $fullname, $prune);
579 sub _find_dir_symlnk($$$);
582 # check whether or not a scalar variable is tainted
583 # (code straight from the Camel, 3rd ed., page 561)
586 my $nada = substr($arg, 0, 0); # zero-length
588 eval { eval "# $nada" };
589 return length($@) != 0;
594 die "invalid top directory" unless defined $_[0];
596 # This function must local()ize everything because callbacks may
597 # call find() or finddepth()
600 local ($wanted_callback, $avoid_nlink, $bydepth, $no_chdir, $follow,
601 $follow_skip, $full_check, $untaint, $untaint_skip, $untaint_pat,
602 $pre_process, $post_process, $dangling_symlinks);
603 local($dir, $name, $fullname, $prune);
606 my $cwd = $wanted->{bydepth} ? Cwd::fastcwd() : Cwd::getcwd();
608 # VMS returns this by default in VMS format which just doesn't
609 # work for the rest of this module.
610 $cwd = VMS::Filespec::unixpath($cwd);
612 # Apparently this is not expected to have a trailing space.
613 # To attempt to make VMS/UNIX conversions mostly reversable,
614 # a trailing slash is needed. The run-time functions ignore the
615 # resulting double slash, but it causes the perl tests to fail.
618 # This comes up in upper case now, but should be lower.
619 # In the future this could be exact case, no need to change.
621 my $cwd_untainted = $cwd;
623 $wanted_callback = $wanted->{wanted};
624 $bydepth = $wanted->{bydepth};
625 $pre_process = $wanted->{preprocess};
626 $post_process = $wanted->{postprocess};
627 $no_chdir = $wanted->{no_chdir};
628 $full_check = $^O eq 'MSWin32' ? 0 : $wanted->{follow};
629 $follow = $^O eq 'MSWin32' ? 0 :
630 $full_check || $wanted->{follow_fast};
631 $follow_skip = $wanted->{follow_skip};
632 $untaint = $wanted->{untaint};
633 $untaint_pat = $wanted->{untaint_pattern};
634 $untaint_skip = $wanted->{untaint_skip};
635 $dangling_symlinks = $wanted->{dangling_symlinks};
637 # for compatibility reasons (find.pl, find2perl)
638 local our ($topdir, $topdev, $topino, $topmode, $topnlink);
640 # a symbolic link to a directory doesn't increase the link count
641 $avoid_nlink = $follow || $File::Find::dont_use_nlink;
643 my ($abs_dir, $Is_Dir);
646 foreach my $TOP (@_) {
649 ($topdev,$topino,$topmode,$topnlink) = $follow ? stat $top_item : lstat $top_item;
652 $top_item = ":$top_item"
653 if ( (-d _) && ( $top_item !~ /:/ ) );
654 } elsif ($^O eq 'MSWin32') {
655 $top_item =~ s|/\z|| unless $top_item =~ m|\w:/$|;
658 $top_item =~ s|/\z|| unless $top_item eq '/';
666 $cwd = "$cwd:" unless ($cwd =~ /:$/); # for safety
668 if ($top_item eq $File::Find::current_dir) {
672 $abs_dir = contract_name_Mac($cwd, $top_item);
673 unless (defined $abs_dir) {
674 warnings::warnif "Can't determine absolute path for $top_item (No such file or directory)\n";
681 if (substr($top_item,0,1) eq '/') {
682 $abs_dir = $top_item;
684 elsif ($top_item eq $File::Find::current_dir) {
687 else { # care about any ../
688 $top_item =~ s/\.dir\z//i if $Is_VMS;
689 $abs_dir = contract_name("$cwd/",$top_item);
692 $abs_dir= Follow_SymLink($abs_dir);
693 unless (defined $abs_dir) {
694 if ($dangling_symlinks) {
695 if (ref $dangling_symlinks eq 'CODE') {
696 $dangling_symlinks->($top_item, $cwd);
698 warnings::warnif "$top_item is a dangling symbolic link\n";
705 $top_item =~ s/\.dir\z//i if $Is_VMS;
706 _find_dir_symlnk($wanted, $abs_dir, $top_item);
712 unless (defined $topnlink) {
713 warnings::warnif "Can't stat $top_item: $!\n";
717 $top_item =~ s/\.dir\z//i if $Is_VMS;
718 _find_dir($wanted, $top_item, $topnlink);
727 unless (($_,$dir) = File::Basename::fileparse($abs_dir)) {
729 ($dir,$_) = (':', $top_item); # $File::Find::dir, $_
732 ($dir,$_) = ('./', $top_item);
737 if (( $untaint ) && (is_tainted($dir) )) {
738 ( $abs_dir ) = $dir =~ m|$untaint_pat|;
739 unless (defined $abs_dir) {
740 if ($untaint_skip == 0) {
741 die "directory $dir is still tainted";
749 unless ($no_chdir || chdir $abs_dir) {
750 warnings::warnif "Couldn't chdir $abs_dir: $!\n";
754 $name = $abs_dir . $_; # $File::Find::name
755 $_ = $name if $no_chdir;
757 { $wanted_callback->() }; # protect against wild "next"
761 unless ( $no_chdir ) {
762 if ( ($check_t_cwd) && (($untaint) && (is_tainted($cwd) )) ) {
763 ( $cwd_untainted ) = $cwd =~ m|$untaint_pat|;
764 unless (defined $cwd_untainted) {
765 die "insecure cwd in find(depth)";
769 unless (chdir $cwd_untainted) {
770 die "Can't cd to $cwd: $!\n";
778 # $p_dir : "parent directory"
779 # $nlink : what came back from the stat
781 # chdir (if not no_chdir) to dir
784 my ($wanted, $p_dir, $nlink) = @_;
785 my ($CdLvl,$Level) = (0,0);
788 my ($subcount,$sub_nlink);
790 my $dir_name= $p_dir;
792 my $dir_rel = $File::Find::current_dir;
797 $dir_pref= ($p_dir =~ /:$/) ? $p_dir : "$p_dir:"; # preface
798 } elsif ($^O eq 'MSWin32') {
799 $dir_pref = ($p_dir =~ m|\w:/?$| ? $p_dir : "$p_dir/" );
800 } elsif ($^O eq 'VMS') {
802 # VMS is returning trailing .dir on directories
803 # and trailing . on files and symbolic links
807 $p_dir =~ s/\.(dir)?$//i unless $p_dir eq '.';
809 $dir_pref = ($p_dir =~ m/[\]>]+$/ ? $p_dir : "$p_dir/" );
812 $dir_pref= ( $p_dir eq '/' ? '/' : "$p_dir/" );
815 local ($dir, $name, $prune, *DIR);
817 unless ( $no_chdir || ($p_dir eq $File::Find::current_dir)) {
819 if (( $untaint ) && (is_tainted($p_dir) )) {
820 ( $udir ) = $p_dir =~ m|$untaint_pat|;
821 unless (defined $udir) {
822 if ($untaint_skip == 0) {
823 die "directory $p_dir is still tainted";
830 unless (chdir ($Is_VMS && $udir !~ /[\/\[<]+/ ? "./$udir" : $udir)) {
831 warnings::warnif "Can't cd to $udir: $!\n";
836 # push the starting directory
837 push @Stack,[$CdLvl,$p_dir,$dir_rel,-1] if $bydepth;
840 $p_dir = $dir_pref; # ensure trailing ':'
843 while (defined $SE) {
845 $dir= $p_dir; # $File::Find::dir
846 $name= $dir_name; # $File::Find::name
847 $_= ($no_chdir ? $dir_name : $dir_rel ); # $_
848 # prune may happen here
850 { $wanted_callback->() }; # protect against wild "next"
854 # change to that directory
855 unless ($no_chdir || ($dir_rel eq $File::Find::current_dir)) {
857 if ( ($untaint) && (($tainted) || ($tainted = is_tainted($dir_rel) )) ) {
858 ( $udir ) = $dir_rel =~ m|$untaint_pat|;
859 unless (defined $udir) {
860 if ($untaint_skip == 0) {
862 die "directory ($p_dir) $dir_rel is still tainted";
865 die "directory (" . ($p_dir ne '/' ? $p_dir : '') . "/) $dir_rel is still tainted";
867 } else { # $untaint_skip == 1
872 unless (chdir ($Is_VMS && $udir !~ /[\/\[<]+/ ? "./$udir" : $udir)) {
874 warnings::warnif "Can't cd to ($p_dir) $udir: $!\n";
877 warnings::warnif "Can't cd to (" .
878 ($p_dir ne '/' ? $p_dir : '') . "/) $udir: $!\n";
886 $dir_name = "$dir_name:" unless ($dir_name =~ /:$/);
889 $dir= $dir_name; # $File::Find::dir
891 # Get the list of files in the current directory.
892 unless (opendir DIR, ($no_chdir ? $dir_name : $File::Find::current_dir)) {
893 warnings::warnif "Can't opendir($dir_name): $!\n";
896 @filenames = readdir DIR;
898 @filenames = $pre_process->(@filenames) if $pre_process;
899 push @Stack,[$CdLvl,$dir_name,"",-2] if $post_process;
901 # default: use whatever was specifid
902 # (if $nlink >= 2, and $avoid_nlink == 0, this will switch back)
903 $no_nlink = $avoid_nlink;
904 # if dir has wrong nlink count, force switch to slower stat method
905 $no_nlink = 1 if ($nlink < 2);
907 if ($nlink == 2 && !$no_nlink) {
908 # This dir has no subdirectories.
909 for my $FN (@filenames) {
911 # Big hammer here - Compensate for VMS trailing . and .dir
912 # No win situation until this is changed, but this
913 # will handle the majority of the cases with breaking the fewest
916 $FN =~ s#\.$## if ($FN ne '.');
918 next if $FN =~ $File::Find::skip_pattern;
920 $name = $dir_pref . $FN; # $File::Find::name
921 $_ = ($no_chdir ? $name : $FN); # $_
922 { $wanted_callback->() }; # protect against wild "next"
927 # This dir has subdirectories.
928 $subcount = $nlink - 2;
930 # HACK: insert directories at this position. so as to preserve
931 # the user pre-processed ordering of files.
932 # EG: directory traversal is in user sorted order, not at random.
933 my $stack_top = @Stack;
935 for my $FN (@filenames) {
936 next if $FN =~ $File::Find::skip_pattern;
937 if ($subcount > 0 || $no_nlink) {
938 # Seen all the subdirs?
939 # check for directoriness.
940 # stat is faster for a file in the current directory
941 $sub_nlink = (lstat ($no_chdir ? $dir_pref . $FN : $FN))[3];
945 $FN =~ s/\.dir\z//i if $Is_VMS;
946 # HACK: replace push to preserve dir traversal order
947 #push @Stack,[$CdLvl,$dir_name,$FN,$sub_nlink];
948 splice @Stack, $stack_top, 0,
949 [$CdLvl,$dir_name,$FN,$sub_nlink];
952 $name = $dir_pref . $FN; # $File::Find::name
953 $_= ($no_chdir ? $name : $FN); # $_
954 { $wanted_callback->() }; # protect against wild "next"
958 $name = $dir_pref . $FN; # $File::Find::name
959 $_= ($no_chdir ? $name : $FN); # $_
960 { $wanted_callback->() }; # protect against wild "next"
966 while ( defined ($SE = pop @Stack) ) {
967 ($Level, $p_dir, $dir_rel, $nlink) = @$SE;
968 if ($CdLvl > $Level && !$no_chdir) {
971 $tmp = (':' x ($CdLvl-$Level)) . ':';
974 $tmp = '[' . ('-' x ($CdLvl-$Level)) . ']';
977 $tmp = join('/',('..') x ($CdLvl-$Level));
979 die "Can't cd to $tmp from $dir_name"
985 # $pdir always has a trailing ':', except for the starting dir,
986 # where $dir_rel eq ':'
987 $dir_name = "$p_dir$dir_rel";
988 $dir_pref = "$dir_name:";
990 elsif ($^O eq 'MSWin32') {
991 $dir_name = ($p_dir =~ m|\w:/?$| ? "$p_dir$dir_rel" : "$p_dir/$dir_rel");
992 $dir_pref = "$dir_name/";
994 elsif ($^O eq 'VMS') {
995 if ($p_dir =~ m/[\]>]+$/) {
997 $dir_name =~ s/([\]>]+)$/.$dir_rel$1/;
998 $dir_pref = $dir_name;
1001 $dir_name = "$p_dir/$dir_rel";
1002 $dir_pref = "$dir_name/";
1006 $dir_name = ($p_dir eq '/' ? "/$dir_rel" : "$p_dir/$dir_rel");
1007 $dir_pref = "$dir_name/";
1010 if ( $nlink == -2 ) {
1011 $name = $dir = $p_dir; # $File::Find::name / dir
1012 $_ = $File::Find::current_dir;
1013 $post_process->(); # End-of-directory processing
1015 elsif ( $nlink < 0 ) { # must be finddepth, report dirname now
1018 if ($dir_rel eq ':') { # must be the top dir, where we started
1019 $name =~ s|:$||; # $File::Find::name
1020 $p_dir = "$p_dir:" unless ($p_dir =~ /:$/);
1022 $dir = $p_dir; # $File::Find::dir
1023 $_ = ($no_chdir ? $name : $dir_rel); # $_
1026 if ( substr($name,-2) eq '/.' ) {
1027 substr($name, length($name) == 2 ? -1 : -2) = '';
1030 $_ = ($no_chdir ? $dir_name : $dir_rel );
1031 if ( substr($_,-2) eq '/.' ) {
1032 substr($_, length($_) == 2 ? -1 : -2) = '';
1035 { $wanted_callback->() }; # protect against wild "next"
1038 push @Stack,[$CdLvl,$p_dir,$dir_rel,-1] if $bydepth;
1048 # $dir_loc : absolute location of a dir
1049 # $p_dir : "parent directory"
1051 # chdir (if not no_chdir) to dir
1053 sub _find_dir_symlnk($$$) {
1054 my ($wanted, $dir_loc, $p_dir) = @_; # $dir_loc is the absolute directory
1058 my $updir_loc = $dir_loc; # untainted parent directory
1060 my $dir_name = $p_dir;
1063 my $dir_rel = $File::Find::current_dir;
1064 my $byd_flag; # flag for pending stack entry if $bydepth
1069 $dir_pref = ($p_dir =~ /:$/) ? "$p_dir" : "$p_dir:";
1070 $loc_pref = ($dir_loc =~ /:$/) ? "$dir_loc" : "$dir_loc:";
1072 $dir_pref = ( $p_dir eq '/' ? '/' : "$p_dir/" );
1073 $loc_pref = ( $dir_loc eq '/' ? '/' : "$dir_loc/" );
1076 local ($dir, $name, $fullname, $prune, *DIR);
1078 unless ($no_chdir) {
1079 # untaint the topdir
1080 if (( $untaint ) && (is_tainted($dir_loc) )) {
1081 ( $updir_loc ) = $dir_loc =~ m|$untaint_pat|; # parent dir, now untainted
1082 # once untainted, $updir_loc is pushed on the stack (as parent directory);
1083 # hence, we don't need to untaint the parent directory every time we chdir
1085 unless (defined $updir_loc) {
1086 if ($untaint_skip == 0) {
1087 die "directory $dir_loc is still tainted";
1094 $ok = chdir($updir_loc) unless ($p_dir eq $File::Find::current_dir);
1096 warnings::warnif "Can't cd to $updir_loc: $!\n";
1101 push @Stack,[$dir_loc,$updir_loc,$p_dir,$dir_rel,-1] if $bydepth;
1104 $p_dir = $dir_pref; # ensure trailing ':'
1107 while (defined $SE) {
1110 # change (back) to parent directory (always untainted)
1111 unless ($no_chdir) {
1112 unless (chdir $updir_loc) {
1113 warnings::warnif "Can't cd to $updir_loc: $!\n";
1117 $dir= $p_dir; # $File::Find::dir
1118 $name= $dir_name; # $File::Find::name
1119 $_= ($no_chdir ? $dir_name : $dir_rel ); # $_
1120 $fullname= $dir_loc; # $File::Find::fullname
1121 # prune may happen here
1123 lstat($_); # make sure file tests with '_' work
1124 { $wanted_callback->() }; # protect against wild "next"
1128 # change to that directory
1129 unless ($no_chdir || ($dir_rel eq $File::Find::current_dir)) {
1130 $updir_loc = $dir_loc;
1131 if ( ($untaint) && (($tainted) || ($tainted = is_tainted($dir_loc) )) ) {
1132 # untaint $dir_loc, what will be pushed on the stack as (untainted) parent dir
1133 ( $updir_loc ) = $dir_loc =~ m|$untaint_pat|;
1134 unless (defined $updir_loc) {
1135 if ($untaint_skip == 0) {
1136 die "directory $dir_loc is still tainted";
1143 unless (chdir $updir_loc) {
1144 warnings::warnif "Can't cd to $updir_loc: $!\n";
1150 $dir_name = "$dir_name:" unless ($dir_name =~ /:$/);
1153 $dir = $dir_name; # $File::Find::dir
1155 # Get the list of files in the current directory.
1156 unless (opendir DIR, ($no_chdir ? $dir_loc : $File::Find::current_dir)) {
1157 warnings::warnif "Can't opendir($dir_loc): $!\n";
1160 @filenames = readdir DIR;
1163 for my $FN (@filenames) {
1165 # Big hammer here - Compensate for VMS trailing . and .dir
1166 # No win situation until this is changed, but this
1167 # will handle the majority of the cases with breaking the fewest.
1169 $FN =~ s/\.dir\z//i;
1170 $FN =~ s#\.$## if ($FN ne '.');
1172 next if $FN =~ $File::Find::skip_pattern;
1174 # follow symbolic links / do an lstat
1175 $new_loc = Follow_SymLink($loc_pref.$FN);
1177 # ignore if invalid symlink
1178 unless (defined $new_loc) {
1179 if (!defined -l _ && $dangling_symlinks) {
1180 if (ref $dangling_symlinks eq 'CODE') {
1181 $dangling_symlinks->($FN, $dir_pref);
1183 warnings::warnif "$dir_pref$FN is a dangling symbolic link\n";
1188 $name = $dir_pref . $FN;
1189 $_ = ($no_chdir ? $name : $FN);
1190 { $wanted_callback->() };
1196 $FN =~ s/\.dir\z//i;
1197 $FN =~ s#\.$## if ($FN ne '.');
1198 $new_loc =~ s/\.dir\z//i;
1199 $new_loc =~ s#\.$## if ($new_loc ne '.');
1201 push @Stack,[$new_loc,$updir_loc,$dir_name,$FN,1];
1204 $fullname = $new_loc; # $File::Find::fullname
1205 $name = $dir_pref . $FN; # $File::Find::name
1206 $_ = ($no_chdir ? $name : $FN); # $_
1207 { $wanted_callback->() }; # protect against wild "next"
1213 while (defined($SE = pop @Stack)) {
1214 ($dir_loc, $updir_loc, $p_dir, $dir_rel, $byd_flag) = @$SE;
1216 # $p_dir always has a trailing ':', except for the starting dir,
1217 # where $dir_rel eq ':'
1218 $dir_name = "$p_dir$dir_rel";
1219 $dir_pref = "$dir_name:";
1220 $loc_pref = ($dir_loc =~ /:$/) ? $dir_loc : "$dir_loc:";
1223 $dir_name = ($p_dir eq '/' ? "/$dir_rel" : "$p_dir/$dir_rel");
1224 $dir_pref = "$dir_name/";
1225 $loc_pref = "$dir_loc/";
1227 if ( $byd_flag < 0 ) { # must be finddepth, report dirname now
1228 unless ($no_chdir || ($dir_rel eq $File::Find::current_dir)) {
1229 unless (chdir $updir_loc) { # $updir_loc (parent dir) is always untainted
1230 warnings::warnif "Can't cd to $updir_loc: $!\n";
1234 $fullname = $dir_loc; # $File::Find::fullname
1235 $name = $dir_name; # $File::Find::name
1237 if ($dir_rel eq ':') { # must be the top dir, where we started
1238 $name =~ s|:$||; # $File::Find::name
1239 $p_dir = "$p_dir:" unless ($p_dir =~ /:$/);
1241 $dir = $p_dir; # $File::Find::dir
1242 $_ = ($no_chdir ? $name : $dir_rel); # $_
1245 if ( substr($name,-2) eq '/.' ) {
1246 substr($name, length($name) == 2 ? -1 : -2) = ''; # $File::Find::name
1248 $dir = $p_dir; # $File::Find::dir
1249 $_ = ($no_chdir ? $dir_name : $dir_rel); # $_
1250 if ( substr($_,-2) eq '/.' ) {
1251 substr($_, length($_) == 2 ? -1 : -2) = '';
1255 lstat($_); # make sure file tests with '_' work
1256 { $wanted_callback->() }; # protect against wild "next"
1259 push @Stack,[$dir_loc, $updir_loc, $p_dir, $dir_rel,-1] if $bydepth;
1269 if ( ref($wanted) eq 'HASH' ) {
1270 unless( exists $wanted->{wanted} and ref( $wanted->{wanted} ) eq 'CODE' ) {
1271 die 'no &wanted subroutine given';
1273 if ( $wanted->{follow} || $wanted->{follow_fast}) {
1274 $wanted->{follow_skip} = 1 unless defined $wanted->{follow_skip};
1276 if ( $wanted->{untaint} ) {
1277 $wanted->{untaint_pattern} = $File::Find::untaint_pattern
1278 unless defined $wanted->{untaint_pattern};
1279 $wanted->{untaint_skip} = 0 unless defined $wanted->{untaint_skip};
1283 elsif( ref( $wanted ) eq 'CODE' ) {
1284 return { wanted => $wanted };
1287 die 'no &wanted subroutine given';
1293 _find_opt(wrap_wanted($wanted), @_);
1297 my $wanted = wrap_wanted(shift);
1298 $wanted->{bydepth} = 1;
1299 _find_opt($wanted, @_);
1303 $File::Find::skip_pattern = qr/^\.{1,2}\z/;
1304 $File::Find::untaint_pattern = qr|^([-+@\w./]+)$|;
1306 # These are hard-coded for now, but may move to hint files.
1309 $File::Find::dont_use_nlink = 1;
1311 elsif ($^O eq 'MacOS') {
1313 $File::Find::dont_use_nlink = 1;
1314 $File::Find::skip_pattern = qr/^Icon\015\z/;
1315 $File::Find::untaint_pattern = qr|^(.+)$|;
1318 # this _should_ work properly on all platforms
1319 # where File::Find can be expected to work
1320 $File::Find::current_dir = File::Spec->curdir || '.';
1322 $File::Find::dont_use_nlink = 1
1323 if $^O eq 'os2' || $^O eq 'dos' || $^O eq 'amigaos' || $^O eq 'MSWin32' ||
1324 $^O eq 'interix' || $^O eq 'cygwin' || $^O eq 'epoc' || $^O eq 'qnx' ||
1327 # Set dont_use_nlink in your hint file if your system's stat doesn't
1328 # report the number of links in a directory as an indication
1329 # of the number of files.
1330 # See, e.g. hints/machten.sh for MachTen 2.2.
1331 unless ($File::Find::dont_use_nlink) {
1333 $File::Find::dont_use_nlink = 1 if ($Config::Config{'dont_use_nlink'});
1336 # We need a function that checks if a scalar is tainted. Either use the
1337 # Scalar::Util module's tainted() function or our (slower) pure Perl
1338 # fallback is_tainted_pp()
1341 eval { require Scalar::Util };
1342 *is_tainted = $@ ? \&is_tainted_pp : \&Scalar::Util::tainted;