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 if
18 your C<mkdir> kernel call won't create more than one level of directory at a
19 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 using
42 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,
55 will be deleted. For the moment, C<rmtree> expects
56 Unix file specification syntax.
60 a boolean value, which if TRUE will cause C<rmtree> to
61 print a message each time it examines a file, giving the
62 name of the file, and indicating whether it's using C<rmdir>
63 or C<unlink> to remove it, or that it's skipping it.
68 a boolean value, which if TRUE will cause C<rmtree> to
69 skip any files to which you do not have delete access
70 (if running under VMS) or write access (if running
71 under another OS). This will change in the future when
72 a criterion for 'delete permission' under OSs other
73 than VMS is settled. (defaults to FALSE)
77 It returns the number of files successfully deleted.
81 Tim Bunce <Tim.Bunce@ig.co.uk>
82 Charles Bailey <bailey@genetics.upenn.edu>
86 This document was last revised 08-Mar-1995, for perl 5.001
94 @ISA = qw( Exporter );
95 @EXPORT = qw( mkpath rmtree );
97 $Is_VMS = $Config{'osname'} eq 'VMS';
100 my($paths, $verbose, $mode) = @_;
101 # $paths -- either a path string or ref to list of paths
102 # $verbose -- optional print "mkdir $path" for each directory created
103 # $mode -- optional permissions, defaults to 0777
105 $mode = 0777 unless defined($mode);
106 $paths = [$paths] unless ref $paths;
108 foreach $path (@$paths){
111 foreach(split(/\//, $path)){
114 print "mkdir @p\n" if $verbose;
115 mkdir("@p",$mode) || croak "mkdir @p: $!";
116 push(@created, "@p");
123 my($roots, $verbose, $safe) = @_;
125 $roots = [$roots] unless ref $roots;
127 foreach $root (@{$roots}) {
131 $root =~ s#\.dir$## if $Is_VMS;
132 @files = map("$root/$_", grep $_!~/^\.{1,2}$/, readdir(D));
134 $count += rmtree(\@files,$verbose,$safe);
136 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
137 print "skipped $root\n" if $verbose;
140 print "rmdir $root\n" if $verbose;
141 (rmdir $root && ++$count) or carp "Can't remove directory $root: $!";
145 ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
146 print "skipped $root\n" if $verbose;
149 print "unlink $root\n" if $verbose;
150 while (-e $root) { # delete all versions under VMS
151 (unlink($root) && ++$count)
152 or carp "Can't unlink file $root: $!";