1 package File::CheckTree;
11 our @ISA = qw(Exporter);
12 our @EXPORT = qw(validate);
16 File::CheckTree - run many filetest checks on a tree
22 $num_warnings = validate( q{
30 /usr -d || warn "What happened to $file?\n"
35 The validate() routine takes a single multiline string consisting of
36 directives, each containing a filename plus a file test to try on it.
37 (The file test may also be a "cd", causing subsequent relative filenames
38 to be interpreted relative to that directory.) After the file test
39 you may put C<|| die> to make it a fatal error if the file test fails.
40 The default is C<|| warn>. The file test may optionally have a "!' prepended
41 to test for the opposite condition. If you do a cd and then list some
42 relative filenames, you may want to indent them slightly for readability.
43 If you supply your own die() or warn() message, you can use $file to
44 interpolate the filename.
46 Filetests may be bunched: "-rwx" tests for all of C<-r>, C<-w>, and C<-x>.
47 Only the first failed test of the bunch will produce a warning.
49 The routine returns the number of warnings issued.
53 File::CheckTree was derived from lib/validate.pl which was
54 written by Larry Wall.
55 Revised by Paul Grassie <F<grassie@perl.com>> in 2002.
59 File::CheckTree used to not display fatal error messages.
60 It used to count only those warnings produced by a generic C<|| warn>
61 (and not those in which the user supplied the message). In addition,
62 the validate() routine would leave the user program in whatever
63 directory was last entered through the use of "cd" directives.
64 These bugs were fixed during the development of perl 5.8.
65 The first fixed version of File::CheckTree was 4.2.
72 my ($starting_dir, $file, $test, $cwd, $oldwarnings);
79 foreach my $check (split /\n/, $_[0]) {
80 my ($testlist, @testlist);
82 # skip blanks/comments
83 next if $check =~ /^\s*#/ || $check =~ /^\s*$/;
86 # should probably check for invalid directives and die
87 # but earlier versions of File::CheckTree did not do this either
89 # split a line like "/foo -r || die"
90 # so that $file is "/foo", $test is "-r || die"
91 # (making special allowance for quoted filenames).
92 if ($check =~ m/^\s*"([^"]+)"\s+(.*?)\s*$/ or
93 $check =~ m/^\s*'([^']+)'\s+(.*?)\s*$/ or
94 $check =~ m/^\s*(\S+?)\s+(\S.*?)\s*$/)
96 ($file, $test) = ($1,$2);
99 die "Malformed line: '$check'";
102 # change a $test like "!-ug || die" to "!-Z || die",
103 # capturing the bundled tests (e.g. "ug") in $2
104 if ($test =~ s/ ^ (!?-) (\w{2,}) \b /$1Z/x) {
106 # split bundled tests, e.g. "ug" to 'u', 'g'
107 @testlist = split(//, $testlist);
110 # put in placeholder Z for stand-alone test
114 # will compare these two later to stop on 1st warning w/in a bundle
115 $oldwarnings = $Warnings;
117 foreach my $one (@testlist) {
118 # examples of $test: "!-Z || die" or "-w || warn"
121 # expand relative $file to full pathname if preceded by cd directive
122 $file = File::Spec->catfile($cwd, $file)
123 if $cwd && !File::Spec->file_name_is_absolute($file);
125 # put filename in after the test operator
126 $this =~ s/(-\w\b)/$1 "\$file"/g;
128 # change the "-Z" representing a bundle with the $one test
129 $this =~ s/-Z/-$one/;
131 # if it's a "cd" directive...
132 if ($this =~ /^cd\b/) {
134 $this .= ' || die "cannot cd to $file\n"';
135 # expand "cd" directive with directory name
136 $this =~ s/\bcd\b/chdir(\$cwd = '$file')/;
139 # add "|| warn" as a default disposition
140 $this .= ' || warn' unless $this =~ /\|\|/;
142 # change a generic ".. || die" or ".. || warn"
143 # to call valmess instead of die/warn directly
144 # valmess will look up the error message from %Val_Message
145 $this =~ s/ ^ ( (\S+) \s+ \S+ ) \s* \|\| \s* (die|warn) \s* $
146 /$1 || valmess('$3', '$2', \$file)/x;
150 # count warnings, either from valmess or '-r || warn "my msg"'
151 # also, call any pre-existing signal handler for __WARN__
152 my $orig_sigwarn = $SIG{__WARN__};
153 local $SIG{__WARN__} = sub {
155 if ( $orig_sigwarn ) {
166 # re-raise an exception caused by a "... || die" test
168 # in case of any cd directives, return from whence we came
169 if ($starting_dir ne cwd) {
170 chdir($starting_dir) || die "$starting_dir: $!";
176 # stop on 1st warning within a bundle of tests
177 last if $Warnings > $oldwarnings;
181 # in case of any cd directives, return from whence we came
182 if ($starting_dir ne cwd) {
183 chdir($starting_dir) || die "chdir $starting_dir: $!";
190 'r' => "is not readable by uid $>.",
191 'w' => "is not writable by uid $>.",
192 'x' => "is not executable by uid $>.",
193 'o' => "is not owned by uid $>.",
194 'R' => "is not readable by you.",
195 'W' => "is not writable by you.",
196 'X' => "is not executable by you.",
197 'O' => "is not owned by you.",
198 'e' => "does not exist.",
199 'z' => "does not have zero size.",
200 's' => "does not have non-zero size.",
201 'f' => "is not a plain file.",
202 'd' => "is not a directory.",
203 'l' => "is not a symbolic link.",
204 'p' => "is not a named pipe (FIFO).",
205 'S' => "is not a socket.",
206 'b' => "is not a block special file.",
207 'c' => "is not a character special file.",
208 'u' => "does not have the setuid bit set.",
209 'g' => "does not have the setgid bit set.",
210 'k' => "does not have the sticky bit set.",
211 'T' => "is not a text file.",
212 'B' => "is not a binary file."
216 my ($disposition, $test, $file) = @_;
219 if ($test =~ / ^ (!?) -(\w) \s* $ /x) {
220 my ($neg, $ftype) = ($1, $2);
222 $ferror = "$file $Val_Message{$ftype}";
225 $ferror =~ s/ is not / should not be / ||
226 $ferror =~ s/ does not / should not / ||
227 $ferror =~ s/ not / /;
231 $ferror = "Can't do $test $file.\n";
234 die "$ferror\n" if $disposition eq 'die';