Commit | Line | Data |
1fc4cb55 |
1 | package File::Path; |
fed7345c |
2 | |
3 | =head1 NAME |
4 | |
1fc4cb55 |
5 | File::Path - create or remove a series of directories |
fed7345c |
6 | |
7 | =head1 SYNOPSIS |
8 | |
1fc4cb55 |
9 | C<use File::Path> |
fed7345c |
10 | |
11 | C<mkpath(['/foo/bar/baz', 'blurfl/quux'], 1, 0711);> |
12 | |
13 | C<rmtree(['foo/bar/baz', 'blurfl/quux'], 1, 1);> |
14 | |
15 | =head1 DESCRIPTION |
16 | |
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: |
20 | |
21 | =over 4 |
22 | |
23 | =item * |
24 | |
25 | the name of the path to create, or a reference |
26 | to a list of paths to create, |
27 | |
28 | =item * |
29 | |
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 |
33 | |
34 | =item * |
35 | |
36 | the numeric mode to use when creating the directories |
37 | (defaults to 0777) |
38 | |
39 | =back |
40 | |
41 | It returns a list of all directories (including intermediates, determined using |
42 | the Unix '/' separator) created. |
43 | |
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: |
47 | |
48 | =over 4 |
49 | |
50 | =item * |
51 | |
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, |
567d72c2 |
55 | will be deleted. |
fed7345c |
56 | |
57 | =item * |
58 | |
59 | a boolean value, which if TRUE will cause C<rmtree> to |
748a9306 |
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. |
fed7345c |
63 | (defaults to FALSE) |
64 | |
65 | =item * |
66 | |
67 | a boolean value, which if TRUE will cause C<rmtree> to |
748a9306 |
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) |
fed7345c |
73 | |
74 | =back |
75 | |
a5f75d66 |
76 | It returns the number of files successfully deleted. Symlinks are |
77 | treated as ordinary files. |
fed7345c |
78 | |
79 | =head1 AUTHORS |
80 | |
1fef88e7 |
81 | Tim Bunce E<lt>F<Tim.Bunce@ig.co.uk>E<gt> |
82 | Charles Bailey E<lt>F<bailey@genetics.upenn.edu>E<gt> |
fed7345c |
83 | |
84 | =head1 REVISION |
85 | |
68dc0745 |
86 | This module was last revised 14-Feb-1996, for perl 5.002. |
87 | $VERSION is 1.0101. |
fed7345c |
88 | |
89 | =cut |
90 | |
91 | require 5.000; |
fed7345c |
92 | use Carp; |
68dc0745 |
93 | use File::Basename; |
fed7345c |
94 | require Exporter; |
68dc0745 |
95 | |
96 | use vars qw( $VERSION @ISA @EXPORT ); |
97 | $VERSION = "1.0101"; |
fed7345c |
98 | @ISA = qw( Exporter ); |
99 | @EXPORT = qw( mkpath rmtree ); |
100 | |
68dc0745 |
101 | my $Is_VMS = $^O eq 'VMS'; |
102 | my $force_writeable = ($^O eq 'os2' || $^O eq 'msdos' || $^O eq 'MSWin32' |
103 | || $^O eq 'amigaos'); |
748a9306 |
104 | |
a5f75d66 |
105 | sub mkpath { |
fed7345c |
106 | my($paths, $verbose, $mode) = @_; |
107 | # $paths -- either a path string or ref to list of paths |
108 | # $verbose -- optional print "mkdir $path" for each directory created |
109 | # $mode -- optional permissions, defaults to 0777 |
110 | local($")="/"; |
111 | $mode = 0777 unless defined($mode); |
112 | $paths = [$paths] unless ref $paths; |
113 | my(@created); |
68dc0745 |
114 | foreach $path (@$paths) { |
748a9306 |
115 | next if -d $path; |
8cc95fdb |
116 | # Logic wants Unix paths, so go with the flow. |
117 | $path = VMS::Filespec::unixify($path) if $Is_VMS; |
68dc0745 |
118 | my $parent = dirname($path); |
119 | push(@created,mkpath($parent, $verbose, $mode)) unless (-d $parent); |
120 | print "mkdir $path\n" if $verbose; |
121 | mkdir($path,$mode) || croak "mkdir $path: $!"; |
122 | push(@created, $path); |
fed7345c |
123 | } |
124 | @created; |
125 | } |
126 | |
127 | sub rmtree { |
128 | my($roots, $verbose, $safe) = @_; |
7301ec2d |
129 | my(@files); |
130 | my($count) = 0; |
fed7345c |
131 | $roots = [$roots] unless ref $roots; |
132 | |
133 | foreach $root (@{$roots}) { |
134 | $root =~ s#/$##; |
a5f75d66 |
135 | if (not -l $root and -d _) { |
fed7345c |
136 | opendir(D,$root); |
bbce6d69 |
137 | @files = readdir(D); |
fed7345c |
138 | closedir(D); |
bbce6d69 |
139 | # Deleting large numbers of files from VMS Files-11 filesystems |
140 | # is faster if done in reverse ASCIIbetical order |
141 | @files = reverse @files if $Is_VMS; |
142 | ($root = VMS::Filespec::unixify($root)) =~ s#\.dir$## if $Is_VMS; |
143 | @files = map("$root/$_", grep $_!~/^\.{1,2}$/,@files); |
fed7345c |
144 | $count += rmtree(\@files,$verbose,$safe); |
748a9306 |
145 | if ($safe && |
146 | ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) { |
147 | print "skipped $root\n" if $verbose; |
148 | next; |
149 | } |
68dc0745 |
150 | chmod 0777, $root or carp "Can't make directory $root writeable: $!" |
151 | if $force_writeable; |
fed7345c |
152 | print "rmdir $root\n" if $verbose; |
153 | (rmdir $root && ++$count) or carp "Can't remove directory $root: $!"; |
154 | } |
155 | else { |
748a9306 |
156 | if ($safe && |
157 | ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) { |
158 | print "skipped $root\n" if $verbose; |
159 | next; |
160 | } |
68dc0745 |
161 | chmod 0666, $root or carp "Can't make file $root writeable: $!" |
162 | if $force_writeable; |
fed7345c |
163 | print "unlink $root\n" if $verbose; |
a5f75d66 |
164 | while (-e $root || -l $root) { # delete all versions under VMS |
4633a7c4 |
165 | (unlink($root) && ++$count) |
36477c24 |
166 | or croak "Can't unlink file $root: $!"; |
4633a7c4 |
167 | } |
fed7345c |
168 | } |
169 | } |
170 | |
171 | $count; |
172 | } |
173 | |
174 | 1; |
175 | |
176 | __END__ |