5 File::Path - create or remove directory trees
11 mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);
12 rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);
16 The C<mkpath> function provides a convenient way to create directories, even
17 if your C<mkdir> kernel call won't create more than one level of directory at
18 a time. C<mkpath> takes three arguments:
24 the name of the path to create, or a reference
25 to a list of paths to create,
29 a boolean value, which if TRUE will cause C<mkpath>
30 to print the name of each directory as it is created
31 (defaults to FALSE), and
35 the numeric mode to use when creating the directories
36 (defaults to 0777), to be modified by the current umask.
40 It returns a list of all directories (including intermediates, determined
41 using the Unix '/' separator) created.
43 If a system error prevents a directory from being created, then the
44 C<mkpath> function throws a fatal error with C<Carp::croak>. This error
45 can be trapped with an C<eval> block:
47 eval { mkpath($dir) };
49 print "Couldn't create $dir: $@";
52 Similarly, the C<rmtree> function provides a convenient way to delete a
53 subtree from the directory structure, much like the Unix command C<rm -r>.
54 C<rmtree> takes three arguments:
60 the root of the subtree to delete, or a reference to
61 a list of roots. All of the files and directories
62 below each root, as well as the roots themselves,
67 a boolean value, which if TRUE will cause C<rmtree> to
68 print a message each time it examines a file, giving the
69 name of the file, and indicating whether it's using C<rmdir>
70 or C<unlink> to remove it, or that it's skipping it.
75 a boolean value, which if TRUE will cause C<rmtree> to
76 skip any files to which you do not have delete access
77 (if running under VMS) or write access (if running
78 under another OS). This will change in the future when
79 a criterion for 'delete permission' under OSs other
80 than VMS is settled. (defaults to FALSE)
84 It returns the number of files successfully deleted. Symlinks are
85 simply deleted and not followed.
87 B<NOTE:> There are race conditions internal to the implementation of
88 C<rmtree> making it unsafe to use on directory trees which may be
89 altered or moved while C<rmtree> is running, and in particular on any
90 directory trees with any path components or subdirectories potentially
91 writable by untrusted users.
93 Additionally, if the third parameter is not TRUE and C<rmtree> is
94 interrupted, it may leave files and directories with permissions altered
95 to allow deletion (and older versions of this module would even set
96 files and directories to world-read/writable!)
98 Note also that the occurrence of errors in C<rmtree> can be determined I<only>
99 by trapping diagnostic messages using C<$SIG{__WARN__}>; it is not apparent
100 from the return value.
108 On Windows, if C<mkpath> gives you the warning: B<No such file or
109 directory>, this may mean that you've exceeded your filesystem's
116 Tim Bunce <F<Tim.Bunce@ig.co.uk>> and
117 Charles Bailey <F<bailey@newman.upenn.edu>>
122 use File::Basename ();
127 our $VERSION = "1.08";
128 our @ISA = qw( Exporter );
129 our @EXPORT = qw( mkpath rmtree );
131 my $Is_VMS = $^O eq 'VMS';
132 my $Is_MacOS = $^O eq 'MacOS';
134 # These OSes complain if you want to remove a file that you have no
135 # write permission to:
136 my $force_writeable = ($^O eq 'os2' || $^O eq 'dos' || $^O eq 'MSWin32' ||
137 $^O eq 'amigaos' || $^O eq 'MacOS' || $^O eq 'epoc');
150 my($paths, $verbose, $mode) = @_;
151 # $paths -- either a path string or ref to list of paths
152 # $verbose -- optional print "mkdir $path" for each directory created
153 # $mode -- optional permissions, defaults to 0777
154 local($")=$Is_MacOS ? ":" : "/";
155 $mode = 0777 unless defined($mode);
156 $paths = [$paths] unless ref $paths;
158 foreach $path (@$paths) {
159 $path .= '/' if $^O eq 'os2' and $path =~ /^\w:\z/s; # feature of CRT
160 # Logic wants Unix paths, so go with the flow.
162 next if $path eq '/';
163 $path = VMS::Filespec::unixify($path);
164 if ($path =~ m:^(/[^/]+)/?\z:) {
165 $path = $1.'/000000';
169 my $parent = File::Basename::dirname($path);
170 unless (-d $parent or $path eq $parent) {
171 push(@created,mkpath($parent, $verbose, $mode));
173 print "mkdir $path\n" if $verbose;
174 unless (mkdir($path,$mode)) {
176 # allow for another process to have created it meanwhile
177 $! = $e, croak ("mkdir $path: $e") unless -d $path;
179 push(@created, $path);
185 my($roots, $verbose, $safe) = @_;
191 if ( defined($roots) && length($roots) ) {
192 $roots = [$roots] unless ref $roots;
195 carp ("No root path(s) specified\n");
200 foreach $root (@{$roots}) {
202 $root = ":$root" if $root !~ /:/;
203 $root =~ s#([^:])\z#$1:#;
207 (undef, undef, my $rp) = lstat $root or next;
208 $rp &= 07777; # don't forget setuid, setgid, sticky bits
210 # notabene: 0700 is for making readable in the first place,
211 # it's also intended to change it to writable in case we have
212 # to recurse in which case we are better than rm -rf for
213 # subtrees with strange permissions
214 chmod($rp | 0700, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
215 or carp ("Can't make directory $root read+writeable: $!")
218 if (opendir my $d, $root) {
220 if (!defined ${"\cTAINT"} or ${"\cTAINT"}) {
221 # Blindly untaint dir names
222 @files = map { /^(.*)$/s ; $1 } readdir $d;
229 carp ("Can't read $root: $!");
233 # Deleting large numbers of files from VMS Files-11 filesystems
234 # is faster if done in reverse ASCIIbetical order
235 @files = reverse @files if $Is_VMS;
236 ($root = VMS::Filespec::unixify($root)) =~ s#\.dir\z## if $Is_VMS;
238 @files = map("$root$_", @files);
240 @files = map("$root/$_", grep $_!~/^\.{1,2}\z/s,@files);
242 $count += rmtree(\@files,$verbose,$safe);
244 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
245 print "skipped $root\n" if $verbose;
248 chmod $rp | 0700, $root
249 or carp ("Can't make directory $root writeable: $!")
251 print "rmdir $root\n" if $verbose;
256 carp ("Can't remove directory $root: $!");
257 chmod($rp, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
258 or carp("and can't restore permissions to "
259 . sprintf("0%o",$rp) . "\n");
264 ($Is_VMS ? !&VMS::Filespec::candelete($root)
265 : !(-l $root || -w $root)))
267 print "skipped $root\n" if $verbose;
270 chmod $rp | 0600, $root
271 or carp ("Can't make file $root writeable: $!")
273 print "unlink $root\n" if $verbose;
274 # delete all versions under VMS
276 unless (unlink $root) {
277 carp ("Can't unlink file $root: $!");
278 if ($force_writeable) {
280 or carp("and can't restore permissions to "
281 . sprintf("0%o",$rp) . "\n");
286 last unless $Is_VMS && lstat $root;