5 File::Path - create or remove a series of directories
11 C<mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);>
13 C<rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);>
17 The C<mkpath> function provides a convenient way to create directories, even
18 if your C<mkdir> kernel call won't create more than one level of directory at
19 a time. C<mkpath> takes three arguments:
25 the name of the path to create, or a reference
26 to a list of paths to create,
30 a boolean value, which if TRUE will cause C<mkpath>
31 to print the name of each directory as it is created
32 (defaults to FALSE), and
36 the numeric mode to use when creating the directories
41 It returns a list of all directories (including intermediates, determined
42 using the Unix '/' separator) created.
44 Similarly, the C<rmtree> function provides a convenient way to delete a
45 subtree from the directory structure, much like the Unix command C<rm -r>.
46 C<rmtree> takes three arguments:
52 the root of the subtree to delete, or a reference to
53 a list of roots. All of the files and directories
54 below each root, as well as the roots themselves,
59 a boolean value, which if TRUE will cause C<rmtree> to
60 print a message each time it examines a file, giving the
61 name of the file, and indicating whether it's using C<rmdir>
62 or C<unlink> to remove it, or that it's skipping it.
67 a boolean value, which if TRUE will cause C<rmtree> to
68 skip any files to which you do not have delete access
69 (if running under VMS) or write access (if running
70 under another OS). This will change in the future when
71 a criterion for 'delete permission' under OSs other
72 than VMS is settled. (defaults to FALSE)
76 It returns the number of files successfully deleted. Symlinks are
77 treated as ordinary files.
79 B<NOTE:> If the third parameter is not TRUE, C<rmtree> is B<unsecure>
80 in the face of failure or interruption. Files and directories which
81 were not deleted may be left with permissions reset to allow world
82 read and write access. Note also that the occurrence of errors in
83 rmtree can be determined I<only> by trapping diagnostic messages
84 using C<$SIG{__WARN__}>; it is not apparent from the return value.
85 Therefore, you must be extremely careful about using C<rmtree($foo,$bar,0>
86 in situations where security is an issue.
90 Tim Bunce <F<Tim.Bunce@ig.co.uk>> and
91 Charles Bailey <F<bailey@newman.upenn.edu>>
95 Current $VERSION is 1.0401.
100 use File::Basename ();
105 use vars qw( $VERSION @ISA @EXPORT );
107 @ISA = qw( Exporter );
108 @EXPORT = qw( mkpath rmtree );
110 my $Is_VMS = $^O eq 'VMS';
112 # These OSes complain if you want to remove a file that you have no
113 # write permission to:
114 my $force_writeable = ($^O eq 'os2' || $^O eq 'dos' || $^O eq 'MSWin32'
115 || $^O eq 'amigaos');
118 my($paths, $verbose, $mode) = @_;
119 # $paths -- either a path string or ref to list of paths
120 # $verbose -- optional print "mkdir $path" for each directory created
121 # $mode -- optional permissions, defaults to 0777
123 $mode = 0777 unless defined($mode);
124 $paths = [$paths] unless ref $paths;
126 foreach $path (@$paths) {
127 $path .= '/' if $^O eq 'os2' and $path =~ /^\w:$/; # feature of CRT
129 # Logic wants Unix paths, so go with the flow.
130 $path = VMS::Filespec::unixify($path) if $Is_VMS;
131 my $parent = File::Basename::dirname($path);
132 # Allow for creation of new logical filesystems under VMS
133 if (not $Is_VMS or $parent !~ m:/[^/]+/000000/?:) {
134 push(@created,mkpath($parent, $verbose, $mode)) unless (-d $parent);
136 print "mkdir $path\n" if $verbose;
137 unless (mkdir($path,$mode)) {
139 # allow for another process to have created it meanwhile
140 croak "mkdir $path: $e" unless -d $path;
142 push(@created, $path);
148 my($roots, $verbose, $safe) = @_;
154 if ( defined($roots) && length($roots) ) {
155 $roots = [$roots] unless ref $roots;
158 carp "No root path(s) specified\n";
163 foreach $root (@{$roots}) {
165 (undef, undef, my $rp) = lstat $root or next;
166 $rp &= 07777; # don't forget setuid, setgid, sticky bits
168 # notabene: 0777 is for making readable in the first place,
169 # it's also intended to change it to writable in case we have
170 # to recurse in which case we are better than rm -rf for
171 # subtrees with strange permissions
172 chmod(0777, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
173 or carp "Can't make directory $root read+writeable: $!"
176 my $d = DirHandle->new($root)
177 or carp "Can't read $root: $!";
181 # Deleting large numbers of files from VMS Files-11 filesystems
182 # is faster if done in reverse ASCIIbetical order
183 @files = reverse @files if $Is_VMS;
184 ($root = VMS::Filespec::unixify($root)) =~ s#\.dir$## if $Is_VMS;
185 @files = map("$root/$_", grep $_!~/^\.{1,2}$/,@files);
186 $count += rmtree(\@files,$verbose,$safe);
188 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
189 print "skipped $root\n" if $verbose;
193 or carp "Can't make directory $root writeable: $!"
195 print "rmdir $root\n" if $verbose;
200 carp "Can't remove directory $root: $!";
201 chmod($rp, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
202 or carp("and can't restore permissions to "
203 . sprintf("0%o",$rp) . "\n");
208 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
209 print "skipped $root\n" if $verbose;
213 or carp "Can't make file $root writeable: $!"
215 print "unlink $root\n" if $verbose;
216 # delete all versions under VMS
218 unless (unlink $root) {
219 carp "Can't unlink file $root: $!";
220 if ($force_writeable) {
222 or carp("and can't restore permissions to "
223 . sprintf("0%o",$rp) . "\n");
228 last unless $Is_VMS && lstat $root;