12 # can't say 'opendir my $dh, $dirname'
13 # need to initialise $dh
19 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
22 @EXPORT = qw(mkpath rmtree);
23 @EXPORT_OK = qw(make_path remove_tree);
25 my $Is_VMS = $^O eq 'VMS';
26 my $Is_MacOS = $^O eq 'MacOS';
28 # These OSes complain if you want to remove a file that you have no
29 # write permission to:
30 my $Force_Writeable = grep {$^O eq $_} qw(amigaos dos epoc MSWin32 MacOS os2);
48 $object = '' unless defined $object;
49 $message .= ": $!" if $!;
50 push @{${$arg->{error}}}, {$object => $message};
53 _carp(defined($object) ? "$message for $object: $!" : "$message: $!");
58 push @_, {} unless @_ and UNIVERSAL::isa($_[-1],'HASH');
63 my $old_style = !(@_ and UNIVERSAL::isa($_[-1],'HASH'));
70 ($paths, $verbose, $mode) = @_;
71 $paths = [$paths] unless UNIVERSAL::isa($paths,'ARRAY');
72 $arg->{verbose} = $verbose;
73 $arg->{mode} = defined $mode ? $mode : 0777;
77 $arg->{mode} = delete $arg->{mask} if exists $arg->{mask};
78 $arg->{mode} = 0777 unless exists $arg->{mode};
79 ${$arg->{error}} = [] if exists $arg->{error};
82 return _mkpath($arg, $paths);
90 foreach $path (@$paths) {
91 next unless defined($path) and length($path);
92 $path .= '/' if $^O eq 'os2' and $path =~ /^\w:\z/s; # feature of CRT
93 # Logic wants Unix paths, so go with the flow.
96 $path = VMS::Filespec::unixify($path);
99 my $parent = File::Basename::dirname($path);
100 unless (-d $parent or $path eq $parent) {
101 push(@created,_mkpath($arg, [$parent]));
103 print "mkdir $path\n" if $arg->{verbose};
104 if (mkdir($path,$arg->{mode})) {
105 push(@created, $path);
109 my ($e, $e1) = ($save_bang, $^E);
110 $e .= "; $e1" if $e ne $e1;
111 # allow for another process to have created it meanwhile
115 push @{${$arg->{error}}}, {$path => $e};
118 _croak("mkdir $path: $e");
127 push @_, {} unless @_ and UNIVERSAL::isa($_[-1],'HASH');
132 my($dir, $test) = @_;
134 my($dv, $dd) = File::Spec->splitpath($dir, 1);
135 my($tv, $td) = File::Spec->splitpath($test, 1);
138 return 0 if $dv ne $tv;
140 my @d = File::Spec->splitdir($dd);
141 my @t = File::Spec->splitdir($td);
143 # @t can't be a subdir if it's shorter than @d
146 return join('/', @d) eq join('/', splice @t, 0, +@d);
150 my $old_style = !(@_ and UNIVERSAL::isa($_[-1],'HASH'));
156 my ($verbose, $safe);
157 ($paths, $verbose, $safe) = @_;
158 $arg->{verbose} = $verbose;
159 $arg->{safe} = defined $safe ? $safe : 0;
161 if (defined($paths) and length($paths)) {
162 $paths = [$paths] unless UNIVERSAL::isa($paths,'ARRAY');
165 _carp ("No root path(s) specified\n");
171 ${$arg->{error}} = [] if exists $arg->{error};
172 ${$arg->{result}} = [] if exists $arg->{result};
180 $arg->{cwd} = getcwd() or do {
181 _error($arg, "cannot fetch initial working directory");
184 for ($arg->{cwd}) { /\A(.*)\Z/; $_ = $1 } # untaint
186 for my $p (@$paths) {
187 # need to fixup case and map \ to / on Windows
188 my $ortho_root = $^O eq 'MSWin32' ? _slash_lc($p) : $p;
189 my $ortho_cwd = $^O eq 'MSWin32' ? _slash_lc($arg->{cwd}) : $arg->{cwd};
190 my $ortho_root_length = length($ortho_root);
191 $ortho_root_length-- if $^O eq 'VMS'; # don't compare '.' with ']'
192 if ($ortho_root_length && _is_subdir($ortho_root, $ortho_cwd)) {
194 _error($arg, "cannot remove path when cwd is $arg->{cwd}", $p);
199 $p = ":$p" unless $p =~ /:/;
200 $p .= ":" unless $p =~ /:\z/;
202 elsif ($^O eq 'MSWin32') {
208 push @clean_path, $p;
211 @{$arg}{qw(device inode perm)} = (lstat $arg->{cwd})[0,1] or do {
212 _error($arg, "cannot stat initial working directory", $arg->{cwd});
216 return _rmtree($arg, \@clean_path);
224 my $curdir = File::Spec->curdir();
225 my $updir = File::Spec->updir();
229 foreach $root (@$paths) {
230 # since we chdir into each directory, it may not be obvious
231 # to figure out where we are if we generate a message about
232 # a file name. We therefore construct a semi-canonical
233 # filename, anchored from the directory being unlinked (as
234 # opposed to being truly canonical, anchored from the root (/).
236 my $canon = $arg->{prefix}
237 ? File::Spec->catfile($arg->{prefix}, $root)
241 my ($ldev, $lino, $perm) = (lstat $root)[0,1,2] or next ROOT_DIR;
244 $root = VMS::Filespec::pathify($root) if $Is_VMS;
246 # see if we can escalate privileges to get in
247 # (e.g. funny protection mask such as -w- instead of rwx)
249 my $nperm = $perm | 0700;
250 if (!($arg->{safe} or $nperm == $perm or chmod($nperm, $root))) {
251 _error($arg, "cannot make child directory read-write-exec", $canon);
254 elsif (!chdir($root)) {
255 _error($arg, "cannot chdir to child", $canon);
260 my ($cur_dev, $cur_inode, $perm) = (stat $curdir)[0,1,2] or do {
261 _error($arg, "cannot stat current working directory", $canon);
265 ($ldev eq $cur_dev and $lino eq $cur_inode)
266 or _croak("directory $canon changed before chdir, expected dev=$ldev ino=$lino, actual dev=$cur_dev ino=$cur_inode, aborting.");
268 $perm &= 07777; # don't forget setuid, setgid, sticky bits
269 my $nperm = $perm | 0700;
271 # notabene: 0700 is for making readable in the first place,
272 # it's also intended to change it to writable in case we have
273 # to recurse in which case we are better than rm -rf for
274 # subtrees with strange permissions
276 if (!($arg->{safe} or $nperm == $perm or chmod($nperm, $curdir))) {
277 _error($arg, "cannot make directory read+writeable", $canon);
282 $d = gensym() if $] < 5.006;
283 if (!opendir $d, $curdir) {
284 _error($arg, "cannot opendir", $canon);
289 if (!defined ${"\cTAINT"} or ${"\cTAINT"}) {
290 # Blindly untaint dir names if taint mode is
291 # active, or any perl < 5.006
292 @files = map { /\A(.*)\z/s; $1 } readdir $d;
301 # Deleting large numbers of files from VMS Files-11
302 # filesystems is faster if done in reverse ASCIIbetical order.
303 # include '.' to '.;' from blead patch #31775
304 @files = map {$_ eq '.' ? '.;' : $_} reverse @files;
305 ($root = VMS::Filespec::unixify($root)) =~ s/\.dir\z//;
307 @files = grep {$_ ne $updir and $_ ne $curdir} @files;
310 # remove the contained files before the directory itself
312 @{$narg}{qw(device inode cwd prefix depth)}
313 = ($cur_dev, $cur_inode, $updir, $canon, $arg->{depth}+1);
314 $count += _rmtree($narg, \@files);
317 # restore directory permissions of required now (in case the rmdir
318 # below fails), while we are still in the directory and may do so
319 # without a race via '.'
320 if ($nperm != $perm and not chmod($perm, $curdir)) {
321 _error($arg, "cannot reset chmod", $canon);
324 # don't leave the client code in an unexpected directory
326 or _croak("cannot chdir to $arg->{cwd} from $canon: $!, aborting.");
328 # ensure that a chdir upwards didn't take us somewhere other
329 # than we expected (see CVE-2002-0435)
330 ($cur_dev, $cur_inode) = (stat $curdir)[0,1]
331 or _croak("cannot stat prior working directory $arg->{cwd}: $!, aborting.");
333 ($arg->{device} eq $cur_dev and $arg->{inode} eq $cur_inode)
334 or _croak("previous directory $arg->{cwd} changed before entering $canon, expected dev=$ldev ino=$lino, actual dev=$cur_dev ino=$cur_inode, aborting.");
336 if ($arg->{depth} or !$arg->{keep_root}) {
338 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
339 print "skipped $root\n" if $arg->{verbose};
342 if ($Force_Writeable and !chmod $perm | 0700, $root) {
343 _error($arg, "cannot make directory writeable", $canon);
345 print "rmdir $root\n" if $arg->{verbose};
347 push @{${$arg->{result}}}, $root if $arg->{result};
351 _error($arg, "cannot remove directory", $canon);
352 if ($Force_Writeable && !chmod($perm, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
354 _error($arg, sprintf("cannot restore permissions to 0%o",$perm), $canon);
361 $root = VMS::Filespec::vmsify("./$root")
363 && !File::Spec->file_name_is_absolute($root)
364 && ($root !~ m/(?<!\^)[\]>]+/); # not already in VMS syntax
367 ($Is_VMS ? !&VMS::Filespec::candelete($root)
368 : !(-l $root || -w $root)))
370 print "skipped $root\n" if $arg->{verbose};
374 my $nperm = $perm & 07777 | 0600;
375 if ($Force_Writeable and $nperm != $perm and not chmod $nperm, $root) {
376 _error($arg, "cannot make file writeable", $canon);
378 print "unlink $canon\n" if $arg->{verbose};
379 # delete all versions under VMS
382 push @{${$arg->{result}}}, $root if $arg->{result};
385 _error($arg, "cannot unlink file", $canon);
386 $Force_Writeable and chmod($perm, $root) or
387 _error($arg, sprintf("cannot restore permissions to 0%o",$perm), $canon);
391 last unless $Is_VMS && lstat $root;
399 # fix up slashes and case on MSWin32 so that we can determine that
400 # c:\path\to\dir is underneath C:/Path/To
411 File::Path - Create or remove directory trees
415 This document describes version 2.07 of File::Path, released
420 use File::Path qw(make_path remove_tree);
422 make_path('foo/bar/baz', '/zug/zwang');
423 make_path('foo/bar/baz', '/zug/zwang', {
428 remove_tree('foo/bar/baz', '/zug/zwang');
429 remove_tree('foo/bar/baz', '/zug/zwang', {
431 error => \my $err_list,
434 # legacy (interface promoted before v2.00)
435 mkpath('/foo/bar/baz');
436 mkpath('/foo/bar/baz', 1, 0711);
437 mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);
438 rmtree('foo/bar/baz', 1, 1);
439 rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);
441 # legacy (interface promoted before v2.06)
442 mkpath('foo/bar/baz', '/zug/zwang', { verbose => 1, mode => 0711 });
443 rmtree('foo/bar/baz', '/zug/zwang', { verbose => 1, mode => 0711 });
447 This module provide a convenient way to create directories of
448 arbitrary depth and to delete an entire directory subtree from the
451 The following functions are provided:
455 =item make_path( $dir1, $dir2, .... )
457 =item make_path( $dir1, $dir2, ...., \%opts )
459 The C<make_path> function creates the given directories if they don't
460 exists before, much like the Unix command C<mkdir -p>.
462 The function accepts a list of directories to be created. Its
463 behaviour may be tuned by an optional hashref appearing as the last
464 parameter on the call.
466 The function returns the list of directories actually created during
467 the call; in scalar context the number of directories created.
469 The following keys are recognised in the option hash:
475 The numeric permissions mode to apply to each created directory
476 (defaults to 0777), to be modified by the current C<umask>. If the
477 directory already exists (and thus does not need to be created),
478 the permissions will not be modified.
480 C<mask> is recognised as an alias for this parameter.
482 =item verbose => $bool
484 If present, will cause C<make_path> to print the name of each directory
485 as it is created. By default nothing is printed.
489 If present, it should be a reference to a scalar.
490 This scalar will be made to reference an array, which will
491 be used to store any errors that are encountered. See the L</"ERROR
492 HANDLING"> section for more information.
494 If this parameter is not used, certain error conditions may raise
495 a fatal error that will cause the program will halt, unless trapped
502 =item mkpath( $dir, $verbose, $mode )
504 =item mkpath( [$dir1, $dir2,...], $verbose, $mode )
506 =item mkpath( $dir1, $dir2,..., \%opt )
508 The mkpath() function provide the legacy interface of make_path() with
509 a different interpretation of the arguments passed. The behaviour and
510 return value of the function is otherwise identical to make_path().
512 =item remove_tree( $dir1, $dir2, .... )
514 =item remove_tree( $dir1, $dir2, ...., \%opts )
516 The C<remove_tree> function deletes the given directories and any
517 files and subdirectories they might contain, much like the Unix
518 command C<rm -r> or C<del /s> on Windows.
520 The function accepts a list of directories to be
521 removed. Its behaviour may be tuned by an optional hashref
522 appearing as the last parameter on the call.
524 The functions returns the number of files successfully deleted.
526 The following keys are recognised in the option hash:
530 =item verbose => $bool
532 If present, will cause C<remove_tree> to print the name of each file as
533 it is unlinked. By default nothing is printed.
537 When set to a true value, will cause C<remove_tree> to skip the files
538 for which the process lacks the required privileges needed to delete
539 files, such as delete privileges on VMS. In other words, the code
540 will make no attempt to alter file permissions. Thus, if the process
541 is interrupted, no filesystem object will be left in a more
544 =item keep_root => $bool
546 When set to a true value, will cause all files and subdirectories
547 to be removed, except the initially specified directories. This comes
548 in handy when cleaning out an application's scratch directory.
550 remove_tree( '/tmp', {keep_root => 1} );
552 =item result => \$res
554 If present, it should be a reference to a scalar.
555 This scalar will be made to reference an array, which will
556 be used to store all files and directories unlinked
557 during the call. If nothing is unlinked, the array will be empty.
559 remove_tree( '/tmp', {result => \my $list} );
560 print "unlinked $_\n" for @$list;
562 This is a useful alternative to the C<verbose> key.
566 If present, it should be a reference to a scalar.
567 This scalar will be made to reference an array, which will
568 be used to store any errors that are encountered. See the L</"ERROR
569 HANDLING"> section for more information.
571 Removing things is a much more dangerous proposition than
572 creating things. As such, there are certain conditions that
573 C<remove_tree> may encounter that are so dangerous that the only
574 sane action left is to kill the program.
576 Use C<error> to trap all that is reasonable (problems with
577 permissions and the like), and let it die if things get out
578 of hand. This is the safest course of action.
584 =item rmtree( $dir, $verbose, $safe )
586 =item rmtree( [$dir1, $dir2,...], $verbose, $safe )
588 =item rmtree( $dir1, $dir2,..., \%opt )
590 The rmtree() function provide the legacy interface of remove_tree()
591 with a different interpretation of the arguments passed. The behaviour
592 and return value of the function is otherwise identical to
597 =head2 ERROR HANDLING
603 The following error handling mechanism is considered
604 experimental and is subject to change pending feedback from
609 If C<make_path> or C<remove_tree> encounter an error, a diagnostic
610 message will be printed to C<STDERR> via C<carp> (for non-fatal
611 errors), or via C<croak> (for fatal errors).
613 If this behaviour is not desirable, the C<error> attribute may be
614 used to hold a reference to a variable, which will be used to store
615 the diagnostics. The variable is made a reference to an array of hash
616 references. Each hash contain a single key/value pair where the key
617 is the name of the file, and the value is the error message (including
618 the contents of C<$!> when appropriate). If a general error is
619 encountered the diagnostic key will be empty.
621 An example usage looks like:
623 remove_tree( 'foo/bar', 'bar/rat', {error => \my $err} );
625 for my $diag (@$err) {
626 my ($file, $message) = %$diag;
628 print "general error: $message\n";
631 print "problem unlinking $file: $message\n";
636 print "No error encountered\n";
639 Note that if no errors are encountered, C<$err> will reference an
640 empty array. This means that C<$err> will always end up TRUE; so you
641 need to test C<@$err> to determine if errors occured.
645 C<File::Path> blindly exports C<mkpath> and C<rmtree> into the
646 current namespace. These days, this is considered bad style, but
647 to change it now would break too much code. Nonetheless, you are
648 invited to specify what it is you are expecting to use:
650 use File::Path 'rmtree';
652 The routines C<make_path> and C<remove_tree> are B<not> exported
653 by default. You must specify which ones you want to use.
655 use File::Path 'remove_tree';
657 Note that a side-effect of the above is that C<mkpath> and C<rmtree>
658 are no longer exported at all. This is due to the way the C<Exporter>
659 module works. If you are migrating a codebase to use the new
660 interface, you will have to list everything explicitly. But that's
661 just good practice anyway.
663 use File::Path qw(remove_tree rmtree);
665 =head3 SECURITY CONSIDERATIONS
667 There were race conditions 1.x implementations of File::Path's
668 C<rmtree> function (although sometimes patched depending on the OS
669 distribution or platform). The 2.0 version contains code to avoid the
670 problem mentioned in CVE-2002-0435.
672 See the following pages for more information:
674 http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=286905
675 http://www.nntp.perl.org/group/perl.perl5.porters/2005/01/msg97623.html
676 http://www.debian.org/security/2005/dsa-696
678 Additionally, unless the C<safe> parameter is set (or the
679 third parameter in the traditional interface is TRUE), should a
680 C<remove_tree> be interrupted, files that were originally in read-only
681 mode may now have their permissions set to a read-write (or "delete
686 FATAL errors will cause the program to halt (C<croak>), since the
687 problem is so severe that it would be dangerous to continue. (This
688 can always be trapped with C<eval>, but it's not a good idea. Under
689 the circumstances, dying is the best thing to do).
691 SEVERE errors may be trapped using the modern interface. If the
692 they are not trapped, or the old interface is used, such an error
693 will cause the program will halt.
695 All other errors may be trapped using the modern interface, otherwise
696 they will be C<carp>ed about. Program execution will not be halted.
700 =item mkdir [path]: [errmsg] (SEVERE)
702 C<make_path> was unable to create the path. Probably some sort of
703 permissions error at the point of departure, or insufficient resources
704 (such as free inodes on Unix).
706 =item No root path(s) specified
708 C<make_path> was not given any paths to create. This message is only
709 emitted if the routine is called with the traditional interface.
710 The modern interface will remain silent if given nothing to do.
712 =item No such file or directory
714 On Windows, if C<make_path> gives you this warning, it may mean that
715 you have exceeded your filesystem's maximum path length.
717 =item cannot fetch initial working directory: [errmsg]
719 C<remove_tree> attempted to determine the initial directory by calling
720 C<Cwd::getcwd>, but the call failed for some reason. No attempt
721 will be made to delete anything.
723 =item cannot stat initial working directory: [errmsg]
725 C<remove_tree> attempted to stat the initial directory (after having
726 successfully obtained its name via C<getcwd>), however, the call
727 failed for some reason. No attempt will be made to delete anything.
729 =item cannot chdir to [dir]: [errmsg]
731 C<remove_tree> attempted to set the working directory in order to
732 begin deleting the objects therein, but was unsuccessful. This is
733 usually a permissions issue. The routine will continue to delete
734 other things, but this directory will be left intact.
736 =item directory [dir] changed before chdir, expected dev=[n] ino=[n], actual dev=[n] ino=[n], aborting. (FATAL)
738 C<remove_tree> recorded the device and inode of a directory, and then
739 moved into it. It then performed a C<stat> on the current directory
740 and detected that the device and inode were no longer the same. As
741 this is at the heart of the race condition problem, the program
742 will die at this point.
744 =item cannot make directory [dir] read+writeable: [errmsg]
746 C<remove_tree> attempted to change the permissions on the current directory
747 to ensure that subsequent unlinkings would not run into problems,
748 but was unable to do so. The permissions remain as they were, and
749 the program will carry on, doing the best it can.
751 =item cannot read [dir]: [errmsg]
753 C<remove_tree> tried to read the contents of the directory in order
754 to acquire the names of the directory entries to be unlinked, but
755 was unsuccessful. This is usually a permissions issue. The
756 program will continue, but the files in this directory will remain
759 =item cannot reset chmod [dir]: [errmsg]
761 C<remove_tree>, after having deleted everything in a directory, attempted
762 to restore its permissions to the original state but failed. The
763 directory may wind up being left behind.
765 =item cannot remove [dir] when cwd is [dir]
767 The current working directory of the program is F</some/path/to/here>
768 and you are attempting to remove an ancestor, such as F</some/path>.
769 The directory tree is left untouched.
771 The solution is to C<chdir> out of the child directory to a place
772 outside the directory tree to be removed.
774 =item cannot chdir to [parent-dir] from [child-dir]: [errmsg], aborting. (FATAL)
776 C<remove_tree>, after having deleted everything and restored the permissions
777 of a directory, was unable to chdir back to the parent. The program
778 halts to avoid a race condition from occurring.
780 =item cannot stat prior working directory [dir]: [errmsg], aborting. (FATAL)
782 C<remove_tree> was unable to stat the parent directory after have returned
783 from the child. Since there is no way of knowing if we returned to
784 where we think we should be (by comparing device and inode) the only
785 way out is to C<croak>.
787 =item previous directory [parent-dir] changed before entering [child-dir], expected dev=[n] ino=[n], actual dev=[n] ino=[n], aborting. (FATAL)
789 When C<remove_tree> returned from deleting files in a child directory, a
790 check revealed that the parent directory it returned to wasn't the one
791 it started out from. This is considered a sign of malicious activity.
793 =item cannot make directory [dir] writeable: [errmsg]
795 Just before removing a directory (after having successfully removed
796 everything it contained), C<remove_tree> attempted to set the permissions
797 on the directory to ensure it could be removed and failed. Program
798 execution continues, but the directory may possibly not be deleted.
800 =item cannot remove directory [dir]: [errmsg]
802 C<remove_tree> attempted to remove a directory, but failed. This may because
803 some objects that were unable to be removed remain in the directory, or
804 a permissions issue. The directory will be left behind.
806 =item cannot restore permissions of [dir] to [0nnn]: [errmsg]
808 After having failed to remove a directory, C<remove_tree> was unable to
809 restore its permissions from a permissive state back to a possibly
810 more restrictive setting. (Permissions given in octal).
812 =item cannot make file [file] writeable: [errmsg]
814 C<remove_tree> attempted to force the permissions of a file to ensure it
815 could be deleted, but failed to do so. It will, however, still attempt
818 =item cannot unlink file [file]: [errmsg]
820 C<remove_tree> failed to remove a file. Probably a permissions issue.
822 =item cannot restore permissions of [file] to [0nnn]: [errmsg]
824 After having failed to remove a file, C<remove_tree> was also unable
825 to restore the permissions on the file to a possibly less permissive
826 setting. (Permissions given in octal).
838 Allows files and directories to be moved to the Trashcan/Recycle
839 Bin (where they may later be restored if necessary) if the operating
840 system supports such functionality. This feature may one day be
841 made available directly in C<File::Path>.
847 When removing directory trees, if you want to examine each file to
848 decide whether to delete it (and possibly leaving large swathes
849 alone), F<File::Find::Rule> offers a convenient and flexible approach
850 to examining directory trees.
856 Please report all bugs on the RT queue:
858 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=File-Path>
860 =head1 ACKNOWLEDGEMENTS
862 Paul Szabo identified the race condition originally, and Brendan
863 O'Dea wrote an implementation for Debian that addressed the problem.
864 That code was used as a basis for the current code. Their efforts
865 are greatly appreciated.
867 Gisle Aas made a number of improvements to the documentation for
868 2.07 and his advice and assistance is also greatly appreciated.
872 Tim Bunce and Charles Bailey. Currently maintained by David Landgren
873 <F<david@landgren.net>>.
877 This module is copyright (C) Charles Bailey, Tim Bunce and
878 David Landgren 1995-2008. All rights reserved.
882 This library is free software; you can redistribute it and/or modify
883 it under the same terms as Perl itself.