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
40 It returns a list of all directories (including intermediates, determined
41 using the Unix '/' separator) created.
43 Similarly, the C<rmtree> function provides a convenient way to delete a
44 subtree from the directory structure, much like the Unix command C<rm -r>.
45 C<rmtree> takes three arguments:
51 the root of the subtree to delete, or a reference to
52 a list of roots. All of the files and directories
53 below each root, as well as the roots themselves,
58 a boolean value, which if TRUE will cause C<rmtree> to
59 print a message each time it examines a file, giving the
60 name of the file, and indicating whether it's using C<rmdir>
61 or C<unlink> to remove it, or that it's skipping it.
66 a boolean value, which if TRUE will cause C<rmtree> to
67 skip any files to which you do not have delete access
68 (if running under VMS) or write access (if running
69 under another OS). This will change in the future when
70 a criterion for 'delete permission' under OSs other
71 than VMS is settled. (defaults to FALSE)
75 It returns the number of files successfully deleted. Symlinks are
76 treated as ordinary files.
78 B<NOTE:> If the third parameter is not TRUE, C<rmtree> is B<unsecure>
79 in the face of failure or interruption. Files and directories which
80 were not deleted may be left with permissions reset to allow world
81 read and write access. Note also that the occurrence of errors in
82 rmtree can be determined I<only> by trapping diagnostic messages
83 using C<$SIG{__WARN__}>; it is not apparent from the return value.
84 Therefore, you must be extremely careful about using C<rmtree($foo,$bar,0>
85 in situations where security is an issue.
89 Tim Bunce <F<Tim.Bunce@ig.co.uk>> and
90 Charles Bailey <F<bailey@newman.upenn.edu>>
95 use File::Basename ();
100 use vars qw( $VERSION @ISA @EXPORT );
102 @ISA = qw( Exporter );
103 @EXPORT = qw( mkpath rmtree );
105 my $Is_VMS = $^O eq 'VMS';
107 # These OSes complain if you want to remove a file that you have no
108 # write permission to:
109 my $force_writeable = ($^O eq 'os2' || $^O eq 'dos' || $^O eq 'MSWin32'
110 || $^O eq 'amigaos');
113 my($paths, $verbose, $mode) = @_;
114 # $paths -- either a path string or ref to list of paths
115 # $verbose -- optional print "mkdir $path" for each directory created
116 # $mode -- optional permissions, defaults to 0777
118 $mode = 0777 unless defined($mode);
119 $paths = [$paths] unless ref $paths;
121 foreach $path (@$paths) {
122 $path .= '/' if $^O eq 'os2' and $path =~ /^\w:$/; # feature of CRT
124 # Logic wants Unix paths, so go with the flow.
125 $path = VMS::Filespec::unixify($path) if $Is_VMS;
126 my $parent = File::Basename::dirname($path);
127 # Allow for creation of new logical filesystems under VMS
128 if (not $Is_VMS or $parent !~ m:/[^/]+/000000/?:) {
129 push(@created,mkpath($parent, $verbose, $mode)) unless (-d $parent);
131 print "mkdir $path\n" if $verbose;
132 unless (mkdir($path,$mode)) {
134 # allow for another process to have created it meanwhile
135 croak "mkdir $path: $e" unless -d $path;
137 push(@created, $path);
143 my($roots, $verbose, $safe) = @_;
149 if ( defined($roots) && length($roots) ) {
150 $roots = [$roots] unless ref $roots;
153 carp "No root path(s) specified\n";
158 foreach $root (@{$roots}) {
160 (undef, undef, my $rp) = lstat $root or next;
161 $rp &= 07777; # don't forget setuid, setgid, sticky bits
163 # notabene: 0777 is for making readable in the first place,
164 # it's also intended to change it to writable in case we have
165 # to recurse in which case we are better than rm -rf for
166 # subtrees with strange permissions
167 chmod(0777, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
168 or carp "Can't make directory $root read+writeable: $!"
171 my $d = DirHandle->new($root)
172 or carp "Can't read $root: $!";
176 # Deleting large numbers of files from VMS Files-11 filesystems
177 # is faster if done in reverse ASCIIbetical order
178 @files = reverse @files if $Is_VMS;
179 ($root = VMS::Filespec::unixify($root)) =~ s#\.dir$## if $Is_VMS;
180 @files = map("$root/$_", grep $_!~/^\.{1,2}$/,@files);
181 $count += rmtree(\@files,$verbose,$safe);
183 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
184 print "skipped $root\n" if $verbose;
188 or carp "Can't make directory $root writeable: $!"
190 print "rmdir $root\n" if $verbose;
195 carp "Can't remove directory $root: $!";
196 chmod($rp, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
197 or carp("and can't restore permissions to "
198 . sprintf("0%o",$rp) . "\n");
203 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
204 print "skipped $root\n" if $verbose;
208 or carp "Can't make file $root writeable: $!"
210 print "unlink $root\n" if $verbose;
211 # delete all versions under VMS
213 unless (unlink $root) {
214 carp "Can't unlink file $root: $!";
215 if ($force_writeable) {
217 or carp("and can't restore permissions to "
218 . sprintf("0%o",$rp) . "\n");
223 last unless $Is_VMS && lstat $root;