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 $old_style = !(@_ and UNIVERSAL::isa($_[-1],'HASH'));
138 my ($verbose, $safe);
139 ($paths, $verbose, $safe) = @_;
140 $arg->{verbose} = $verbose;
141 $arg->{safe} = defined $safe ? $safe : 0;
143 if (defined($paths) and length($paths)) {
144 $paths = [$paths] unless UNIVERSAL::isa($paths,'ARRAY');
147 _carp ("No root path(s) specified\n");
153 ${$arg->{error}} = [] if exists $arg->{error};
154 ${$arg->{result}} = [] if exists $arg->{result};
162 $arg->{cwd} = getcwd() or do {
163 _error($arg, "cannot fetch initial working directory");
166 for ($arg->{cwd}) { /\A(.*)\Z/; $_ = $1 } # untaint
168 for my $p (@$paths) {
169 # need to fixup case and map \ to / on Windows
170 my $ortho_root = $^O eq 'MSWin32' ? _slash_lc($p) : $p;
171 my $ortho_cwd = $^O eq 'MSWin32' ? _slash_lc($arg->{cwd}) : $arg->{cwd};
172 my $ortho_root_length = length($ortho_root);
173 $ortho_root_length-- if $^O eq 'VMS'; # don't compare '.' with ']'
174 if ($ortho_root_length
175 && (substr($ortho_root, 0, $ortho_root_length)
176 eq substr($ortho_cwd, 0, $ortho_root_length))) {
178 _error($arg, "cannot remove path when cwd is $arg->{cwd}", $p);
183 $p = ":$p" unless $p =~ /:/;
184 $p .= ":" unless $p =~ /:\z/;
186 elsif ($^O eq 'MSWin32') {
192 push @clean_path, $p;
195 @{$arg}{qw(device inode perm)} = (lstat $arg->{cwd})[0,1] or do {
196 _error($arg, "cannot stat initial working directory", $arg->{cwd});
200 return _rmtree($arg, \@clean_path);
208 my $curdir = File::Spec->curdir();
209 my $updir = File::Spec->updir();
213 foreach $root (@$paths) {
214 # since we chdir into each directory, it may not be obvious
215 # to figure out where we are if we generate a message about
216 # a file name. We therefore construct a semi-canonical
217 # filename, anchored from the directory being unlinked (as
218 # opposed to being truly canonical, anchored from the root (/).
220 my $canon = $arg->{prefix}
221 ? File::Spec->catfile($arg->{prefix}, $root)
225 my ($ldev, $lino, $perm) = (lstat $root)[0,1,2] or next ROOT_DIR;
228 $root = VMS::Filespec::pathify($root) if $Is_VMS;
230 # see if we can escalate privileges to get in
231 # (e.g. funny protection mask such as -w- instead of rwx)
233 my $nperm = $perm | 0700;
234 if (!($arg->{safe} or $nperm == $perm or chmod($nperm, $root))) {
235 _error($arg, "cannot make child directory read-write-exec", $canon);
238 elsif (!chdir($root)) {
239 _error($arg, "cannot chdir to child", $canon);
244 my ($cur_dev, $cur_inode, $perm) = (stat $curdir)[0,1,2] or do {
245 _error($arg, "cannot stat current working directory", $canon);
249 ($ldev eq $cur_dev and $lino eq $cur_inode)
250 or _croak("directory $canon changed before chdir, expected dev=$ldev ino=$lino, actual dev=$cur_dev ino=$cur_inode, aborting.");
252 $perm &= 07777; # don't forget setuid, setgid, sticky bits
253 my $nperm = $perm | 0700;
255 # notabene: 0700 is for making readable in the first place,
256 # it's also intended to change it to writable in case we have
257 # to recurse in which case we are better than rm -rf for
258 # subtrees with strange permissions
260 if (!($arg->{safe} or $nperm == $perm or chmod($nperm, $curdir))) {
261 _error($arg, "cannot make directory read+writeable", $canon);
266 $d = gensym() if $] < 5.006;
267 if (!opendir $d, $curdir) {
268 _error($arg, "cannot opendir", $canon);
273 if (!defined ${"\cTAINT"} or ${"\cTAINT"}) {
274 # Blindly untaint dir names if taint mode is
275 # active, or any perl < 5.006
276 @files = map { /\A(.*)\z/s; $1 } readdir $d;
285 # Deleting large numbers of files from VMS Files-11
286 # filesystems is faster if done in reverse ASCIIbetical order.
287 # include '.' to '.;' from blead patch #31775
288 @files = map {$_ eq '.' ? '.;' : $_} reverse @files;
289 ($root = VMS::Filespec::unixify($root)) =~ s/\.dir\z//;
291 @files = grep {$_ ne $updir and $_ ne $curdir} @files;
294 # remove the contained files before the directory itself
296 @{$narg}{qw(device inode cwd prefix depth)}
297 = ($cur_dev, $cur_inode, $updir, $canon, $arg->{depth}+1);
298 $count += _rmtree($narg, \@files);
301 # restore directory permissions of required now (in case the rmdir
302 # below fails), while we are still in the directory and may do so
303 # without a race via '.'
304 if ($nperm != $perm and not chmod($perm, $curdir)) {
305 _error($arg, "cannot reset chmod", $canon);
308 # don't leave the client code in an unexpected directory
310 or _croak("cannot chdir to $arg->{cwd} from $canon: $!, aborting.");
312 # ensure that a chdir upwards didn't take us somewhere other
313 # than we expected (see CVE-2002-0435)
314 ($cur_dev, $cur_inode) = (stat $curdir)[0,1]
315 or _croak("cannot stat prior working directory $arg->{cwd}: $!, aborting.");
317 ($arg->{device} eq $cur_dev and $arg->{inode} eq $cur_inode)
318 or _croak("previous directory $arg->{cwd} changed before entering $canon, expected dev=$ldev ino=$lino, actual dev=$cur_dev ino=$cur_inode, aborting.");
320 if ($arg->{depth} or !$arg->{keep_root}) {
322 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
323 print "skipped $root\n" if $arg->{verbose};
326 if ($Force_Writeable and !chmod $perm | 0700, $root) {
327 _error($arg, "cannot make directory writeable", $canon);
329 print "rmdir $root\n" if $arg->{verbose};
331 push @{${$arg->{result}}}, $root if $arg->{result};
335 _error($arg, "cannot remove directory", $canon);
336 if (!chmod($perm, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
338 _error($arg, sprintf("cannot restore permissions to 0%o",$perm), $canon);
345 $root = VMS::Filespec::vmsify("./$root")
347 && !File::Spec->file_name_is_absolute($root)
348 && ($root !~ m/(?<!\^)[\]>]+/); # not already in VMS syntax
351 ($Is_VMS ? !&VMS::Filespec::candelete($root)
352 : !(-l $root || -w $root)))
354 print "skipped $root\n" if $arg->{verbose};
358 my $nperm = $perm & 07777 | 0600;
359 if ($Force_Writeable and $nperm != $perm and not chmod $nperm, $root) {
360 _error($arg, "cannot make file writeable", $canon);
362 print "unlink $canon\n" if $arg->{verbose};
363 # delete all versions under VMS
366 push @{${$arg->{result}}}, $root if $arg->{result};
369 _error($arg, "cannot unlink file", $canon);
370 $Force_Writeable and chmod($perm, $root) or
371 _error($arg, sprintf("cannot restore permissions to 0%o",$perm), $canon);
375 last unless $Is_VMS && lstat $root;
383 # fix up slashes and case on MSWin32 so that we can determine that
384 # c:\path\to\dir is underneath C:/Path/To
395 File::Path - Create or remove directory trees
399 This document describes version 2.07 of File::Path, released
404 use File::Path qw(make_path remove_tree);
406 make_path('foo/bar/baz', '/zug/zwang');
407 make_path('foo/bar/baz', '/zug/zwang', {
412 remove_tree('foo/bar/baz', '/zug/zwang');
413 remove_tree('foo/bar/baz', '/zug/zwang', {
415 error => \my $err_list,
418 # legacy (interface promoted before v2.00)
419 mkpath('/foo/bar/baz');
420 mkpath('/foo/bar/baz', 1, 0711);
421 mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);
422 rmtree('foo/bar/baz', 1, 1);
423 rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);
425 # legacy (interface promoted before v2.06)
426 mkpath('foo/bar/baz', '/zug/zwang', { verbose => 1, mode => 0711 });
427 rmtree('foo/bar/baz', '/zug/zwang', { verbose => 1, mode => 0711 });
431 This module provide a convenient way to create directories of
432 arbitrary depth and to delete an entire directory subtree from the
435 The following functions are provided:
439 =item make_path( $dir1, $dir2, .... )
441 =item make_path( $dir1, $dir2, ...., \%opts )
443 The C<make_path> function creates the given directories if they don't
444 exists before, much like the Unix command C<mkdir -p>.
446 The function accepts a list of directories to be created. Its
447 behaviour may be tuned by an optional hashref appearing as the last
448 parameter on the call.
450 The function returns the list of directories actually created during
451 the call; in scalar context the number of directories created.
453 The following keys are recognised in the option hash:
459 The numeric permissions mode to apply to each created directory
460 (defaults to 0777), to be modified by the current C<umask>. If the
461 directory already exists (and thus does not need to be created),
462 the permissions will not be modified.
464 C<mask> is recognised as an alias for this parameter.
466 =item verbose => $bool
468 If present, will cause C<make_path> to print the name of each directory
469 as it is created. By default nothing is printed.
473 If present, it should be a reference to a scalar.
474 This scalar will be made to reference an array, which will
475 be used to store any errors that are encountered. See the L</"ERROR
476 HANDLING"> section for more information.
478 If this parameter is not used, certain error conditions may raise
479 a fatal error that will cause the program will halt, unless trapped
486 =item mkpath( $dir, $verbose, $mode )
488 =item mkpath( [$dir1, $dir2,...], $verbose, $mode )
490 =item mkpath( $dir1, $dir2,..., \%opt )
492 The mkpath() function provide the legacy interface of make_path() with
493 a different interpretation of the arguments passed. The behaviour and
494 return value of the function is otherwise identical to make_path().
496 =item remove_tree( $dir1, $dir2, .... )
498 =item remove_tree( $dir1, $dir2, ...., \%opts )
500 The C<remove_tree> function deletes the given directories and any
501 files and subdirectories they might contain, much like the Unix
502 command C<rm -r> or C<del /s> on Windows.
504 The function accepts a list of directories to be
505 removed. Its behaviour may be tuned by an optional hashref
506 appearing as the last parameter on the call.
508 The functions returns the number of files successfully deleted.
510 The following keys are recognised in the option hash:
514 =item verbose => $bool
516 If present, will cause C<remove_tree> to print the name of each file as
517 it is unlinked. By default nothing is printed.
521 When set to a true value, will cause C<remove_tree> to skip the files
522 for which the process lacks the required privileges needed to delete
523 files, such as delete privileges on VMS. In other words, the code
524 will make no attempt to alter file permissions. Thus, if the process
525 is interrupted, no filesystem object will be left in a more
528 =item keep_root => $bool
530 When set to a true value, will cause all files and subdirectories
531 to be removed, except the initially specified directories. This comes
532 in handy when cleaning out an application's scratch directory.
534 remove_tree( '/tmp', {keep_root => 1} );
536 =item result => \$res
538 If present, it should be a reference to a scalar.
539 This scalar will be made to reference an array, which will
540 be used to store all files and directories unlinked
541 during the call. If nothing is unlinked, the array will be empty.
543 remove_tree( '/tmp', {result => \my $list} );
544 print "unlinked $_\n" for @$list;
546 This is a useful alternative to the C<verbose> key.
550 If present, it should be a reference to a scalar.
551 This scalar will be made to reference an array, which will
552 be used to store any errors that are encountered. See the L</"ERROR
553 HANDLING"> section for more information.
555 Removing things is a much more dangerous proposition than
556 creating things. As such, there are certain conditions that
557 C<remove_tree> may encounter that are so dangerous that the only
558 sane action left is to kill the program.
560 Use C<error> to trap all that is reasonable (problems with
561 permissions and the like), and let it die if things get out
562 of hand. This is the safest course of action.
568 =item rmtree( $dir, $verbose, $safe )
570 =item rmtree( [$dir1, $dir2,...], $verbose, $safe )
572 =item rmtree( $dir1, $dir2,..., \%opt )
574 The rmtree() function provide the legacy interface of remove_tree()
575 with a different interpretation of the arguments passed. The behaviour
576 and return value of the function is otherwise identical to
581 =head2 ERROR HANDLING
587 The following error handling mechanism is considered
588 experimental and is subject to change pending feedback from
593 If C<make_path> or C<remove_tree> encounter an error, a diagnostic
594 message will be printed to C<STDERR> via C<carp> (for non-fatal
595 errors), or via C<croak> (for fatal errors).
597 If this behaviour is not desirable, the C<error> attribute may be
598 used to hold a reference to a variable, which will be used to store
599 the diagnostics. The variable is made a reference to an array of hash
600 references. Each hash contain a single key/value pair where the key
601 is the name of the file, and the value is the error message (including
602 the contents of C<$!> when appropriate). If a general error is
603 encountered the diagnostic key will be empty.
605 An example usage looks like:
607 remove_tree( 'foo/bar', 'bar/rat', {error => \my $err} );
609 for my $diag (@$err) {
610 my ($file, $message) = %$diag;
612 print "general error: $message\n";
615 print "problem unlinking $file: $message\n";
620 print "No error encountered\n";
623 Note that if no errors are encountered, C<$err> will reference an
624 empty array. This means that C<$err> will always end up TRUE; so you
625 need to test C<@$err> to determine if errors occured.
629 C<File::Path> blindly exports C<mkpath> and C<rmtree> into the
630 current namespace. These days, this is considered bad style, but
631 to change it now would break too much code. Nonetheless, you are
632 invited to specify what it is you are expecting to use:
634 use File::Path 'rmtree';
636 The routines C<make_path> and C<remove_tree> are B<not> exported
637 by default. You must specify which ones you want to use.
639 use File::Path 'remove_tree';
641 Note that a side-effect of the above is that C<mkpath> and C<rmtree>
642 are no longer exported at all. This is due to the way the C<Exporter>
643 module works. If you are migrating a codebase to use the new
644 interface, you will have to list everything explicitly. But that's
645 just good practice anyway.
647 use File::Path qw(remove_tree rmtree);
649 =head3 SECURITY CONSIDERATIONS
651 There were race conditions 1.x implementations of File::Path's
652 C<rmtree> function (although sometimes patched depending on the OS
653 distribution or platform). The 2.0 version contains code to avoid the
654 problem mentioned in CVE-2002-0435.
656 See the following pages for more information:
658 http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=286905
659 http://www.nntp.perl.org/group/perl.perl5.porters/2005/01/msg97623.html
660 http://www.debian.org/security/2005/dsa-696
662 Additionally, unless the C<safe> parameter is set (or the
663 third parameter in the traditional interface is TRUE), should a
664 C<remove_tree> be interrupted, files that were originally in read-only
665 mode may now have their permissions set to a read-write (or "delete
670 FATAL errors will cause the program to halt (C<croak>), since the
671 problem is so severe that it would be dangerous to continue. (This
672 can always be trapped with C<eval>, but it's not a good idea. Under
673 the circumstances, dying is the best thing to do).
675 SEVERE errors may be trapped using the modern interface. If the
676 they are not trapped, or the old interface is used, such an error
677 will cause the program will halt.
679 All other errors may be trapped using the modern interface, otherwise
680 they will be C<carp>ed about. Program execution will not be halted.
684 =item mkdir [path]: [errmsg] (SEVERE)
686 C<make_path> was unable to create the path. Probably some sort of
687 permissions error at the point of departure, or insufficient resources
688 (such as free inodes on Unix).
690 =item No root path(s) specified
692 C<make_path> was not given any paths to create. This message is only
693 emitted if the routine is called with the traditional interface.
694 The modern interface will remain silent if given nothing to do.
696 =item No such file or directory
698 On Windows, if C<make_path> gives you this warning, it may mean that
699 you have exceeded your filesystem's maximum path length.
701 =item cannot fetch initial working directory: [errmsg]
703 C<remove_tree> attempted to determine the initial directory by calling
704 C<Cwd::getcwd>, but the call failed for some reason. No attempt
705 will be made to delete anything.
707 =item cannot stat initial working directory: [errmsg]
709 C<remove_tree> attempted to stat the initial directory (after having
710 successfully obtained its name via C<getcwd>), however, the call
711 failed for some reason. No attempt will be made to delete anything.
713 =item cannot chdir to [dir]: [errmsg]
715 C<remove_tree> attempted to set the working directory in order to
716 begin deleting the objects therein, but was unsuccessful. This is
717 usually a permissions issue. The routine will continue to delete
718 other things, but this directory will be left intact.
720 =item directory [dir] changed before chdir, expected dev=[n] ino=[n], actual dev=[n] ino=[n], aborting. (FATAL)
722 C<remove_tree> recorded the device and inode of a directory, and then
723 moved into it. It then performed a C<stat> on the current directory
724 and detected that the device and inode were no longer the same. As
725 this is at the heart of the race condition problem, the program
726 will die at this point.
728 =item cannot make directory [dir] read+writeable: [errmsg]
730 C<remove_tree> attempted to change the permissions on the current directory
731 to ensure that subsequent unlinkings would not run into problems,
732 but was unable to do so. The permissions remain as they were, and
733 the program will carry on, doing the best it can.
735 =item cannot read [dir]: [errmsg]
737 C<remove_tree> tried to read the contents of the directory in order
738 to acquire the names of the directory entries to be unlinked, but
739 was unsuccessful. This is usually a permissions issue. The
740 program will continue, but the files in this directory will remain
743 =item cannot reset chmod [dir]: [errmsg]
745 C<remove_tree>, after having deleted everything in a directory, attempted
746 to restore its permissions to the original state but failed. The
747 directory may wind up being left behind.
749 =item cannot remove [dir] when cwd is [dir]
751 The current working directory of the program is F</some/path/to/here>
752 and you are attempting to remove an ancestor, such as F</some/path>.
753 The directory tree is left untouched.
755 The solution is to C<chdir> out of the child directory to a place
756 outside the directory tree to be removed.
758 =item cannot chdir to [parent-dir] from [child-dir]: [errmsg], aborting. (FATAL)
760 C<remove_tree>, after having deleted everything and restored the permissions
761 of a directory, was unable to chdir back to the parent. The program
762 halts to avoid a race condition from occurring.
764 =item cannot stat prior working directory [dir]: [errmsg], aborting. (FATAL)
766 C<remove_tree> was unable to stat the parent directory after have returned
767 from the child. Since there is no way of knowing if we returned to
768 where we think we should be (by comparing device and inode) the only
769 way out is to C<croak>.
771 =item previous directory [parent-dir] changed before entering [child-dir], expected dev=[n] ino=[n], actual dev=[n] ino=[n], aborting. (FATAL)
773 When C<remove_tree> returned from deleting files in a child directory, a
774 check revealed that the parent directory it returned to wasn't the one
775 it started out from. This is considered a sign of malicious activity.
777 =item cannot make directory [dir] writeable: [errmsg]
779 Just before removing a directory (after having successfully removed
780 everything it contained), C<remove_tree> attempted to set the permissions
781 on the directory to ensure it could be removed and failed. Program
782 execution continues, but the directory may possibly not be deleted.
784 =item cannot remove directory [dir]: [errmsg]
786 C<remove_tree> attempted to remove a directory, but failed. This may because
787 some objects that were unable to be removed remain in the directory, or
788 a permissions issue. The directory will be left behind.
790 =item cannot restore permissions of [dir] to [0nnn]: [errmsg]
792 After having failed to remove a directory, C<remove_tree> was unable to
793 restore its permissions from a permissive state back to a possibly
794 more restrictive setting. (Permissions given in octal).
796 =item cannot make file [file] writeable: [errmsg]
798 C<remove_tree> attempted to force the permissions of a file to ensure it
799 could be deleted, but failed to do so. It will, however, still attempt
802 =item cannot unlink file [file]: [errmsg]
804 C<remove_tree> failed to remove a file. Probably a permissions issue.
806 =item cannot restore permissions of [file] to [0nnn]: [errmsg]
808 After having failed to remove a file, C<remove_tree> was also unable
809 to restore the permissions on the file to a possibly less permissive
810 setting. (Permissions given in octal).
822 Allows files and directories to be moved to the Trashcan/Recycle
823 Bin (where they may later be restored if necessary) if the operating
824 system supports such functionality. This feature may one day be
825 made available directly in C<File::Path>.
831 When removing directory trees, if you want to examine each file to
832 decide whether to delete it (and possibly leaving large swathes
833 alone), F<File::Find::Rule> offers a convenient and flexible approach
834 to examining directory trees.
840 Please report all bugs on the RT queue:
842 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=File-Path>
844 =head1 ACKNOWLEDGEMENTS
846 Paul Szabo identified the race condition originally, and Brendan
847 O'Dea wrote an implementation for Debian that addressed the problem.
848 That code was used as a basis for the current code. Their efforts
849 are greatly appreciated.
851 Gisle Aas made a number of improvements to the documentation for
852 2.07 and his advice and assistance is also greatly appreciated.
856 Tim Bunce and Charles Bailey. Currently maintained by David Landgren
857 <F<david@landgren.net>>.
861 This module is copyright (C) Charles Bailey, Tim Bunce and
862 David Landgren 1995-2008. All rights reserved.
866 This library is free software; you can redistribute it and/or modify
867 it under the same terms as Perl itself.