Toader/Render/Page/Cleanup.pm

filter: Statementstmt 8.3% 14 / 167 Branchbran 0.0% 0 / 80 Conditioncond 0.0% 0 / 30 MC/DCmcdc 0.0% 0 / 15 Subroutinesub 66.6% 4 / 6 Podpod 100% 2 / 2 totaltotal 6.6% 20 / 300 CC 51 SCAR 74.8
CC
51
Cov
5%
cleanup
2162.0
new
42.0
BEGIN
1.0
CRAP 1780.5
« Toader/Render/Entry/Cleanup.pm ↑ Summary Toader/Render/AutoDoc.pm »
1 package Toader::Render::Page::Cleanup;
2  
3 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 1 ▶use base 'Error::Helper';
Subroutine BEGIN: called CC=1 SCAR=0.0
6 1 ▶use Toader::pathHelper;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 =head1 NAME
9  
10 Toader::Render::Page::Cleanup - This is used for cleaning up the output directory prior to rendering.
11  
12 =head1 VERSION
13  
14 Version 0.1.0
15  
16 =cut
17  
18 1 our $VERSION = '0.1.0';
19  
20  
21 =head1 SYNOPSIS
22  
23 =head1 METHODS
24  
25 =head2 new
26  
27 This initiates the object.
28  
29 One argument is required and it is a L<Toader> object.
30  
31 my $foo=Toader::Render::Page::Cleanup->new($toader);
32 if($foo->error){
33 warn('error: '.$foo->error.":".$foo->errorString);
34 }
35  
36 =cut
37  
38 0 ▶sub new{
Subroutine new: not called CC=6 SCAR=37.4
Pod documented
39 0 my $toader=$_[1];
40  
41 0 my $self={
42 error=>undef,
43 errorString=>'',
44 perror=>undef,
45 errorExtra=>{
46 flags=>{
47 1=>'noToaderObj',
48 2=>'notAtoaderObj',
49 3=>'toaderPerror',
50 4=>'notApageObj',
51 5=>'noObj',
52 6=>'noOutputdirSet',
53 7=>'outputDirDoesNotExist',
54 8=>'objPerror',
55 9=>'noDirSet',
56 10=>'pathhelperErrored',
57 11=>'cleanupFailed',
58 },
59 },
60 };
61 0 bless $self;
62  
63 #make sure something passed to this method
64 0 ▶ if ( ! defined( $toader ) ){
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $toader) 0 0 0
65 0 $self->{error}=1;
66 0 $self->{errorString}='No Toader object passed';
67 0 $self->{perror}=1;
68 0 $self->warn;
69 0 return $self;
70 }
71  
72 #makes sure the object passed is a Toader object
73 0 ▶ if ( ref( $toader ) ne 'Toader' ){
Branch: 1 branch
BranchTrueFalseTotal
if (ref $toader ne "Toader") 0 0 0
74 0 $self->{error}=2;
75 0 $self->{errorString}='The passed object is not a Toader object, but a "'
76 .ref( $toader ).'"';
77 0 $self->{perror}=1;
78 0 $self->warn;
79 0 return $self;
80 }
81  
82 #makes sure the toader object is not in a permanent error state
83 0 $toader->errorblank;
84 0 ▶ if ( $toader->error ){
Branch: 1 branch
BranchTrueFalseTotal
if ($toader->error) 0 0 0
85 0 $self->{perror}=1;
86 0 $self->{error}=3;
87 0 $self->{errorString}='The Toader object passed has a permanent error set. error="'.
88 $toader->error.'" errorString="'.$toader->errorString.'"';
89 0 $self->warn;
90 0 return $self;
91 }
92  
93 0 $self->{toader}=$toader;
94  
95 #makes sure a output directory is set
96 0 my $outputdir=$self->{toader}->getOutputDir;
97 0 ▶ if( ! defined( $outputdir ) ){
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $outputdir) 0 0 0
98 0 $self->{error}=6;
99 0 $self->{errorString}='The Toader object has not had a output directory set';
100 0 $self->warn;
101 0 return undef;
102 }
103 0 $self->{outputdir}=$outputdir;
104  
105 #make sure the output directory exists
106 0 ▶ if( ! -d $outputdir ){
Branch: 1 branch
BranchTrueFalseTotal
unless (-d $outputdir) 0 0 0
107 0 $self->{error}=7;
108 0 $self->{errorString}='The output directory does not exist or does not appear to be a directory';
109 0 $self->warn;
110 0 return undef;
111 }
112  
113 #gets the pathhelper for later usage
114 0 $self->{pathhelper}=$self->{toader}->getPathHelper;
115  
116 0 return $self;
117 }
118  
119 =head2 cleanup
120  
121 This cleans up the output directory for a specified object.
122  
123 One argument is taken and that is the object to be cleaned from
124 the output directory.
125  
126 $foo->cleanup( $obj );
127 if($foo->error){
128 warn('error: '.$foo->error.":".$foo->errorString);
129 }
130  
131 =cut
132  
133 0 ▶sub cleanup{
Subroutine cleanup: not called CC=46 SCAR=76.8
Pod documented
134 0 my $self=$_[0];
135 0 my $obj=$_[1];
136  
137 0 ▶ if (!$self->errorblank){
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->errorblank) 0 0 0
138 0 return undef;
139 }
140  
141 #make sure a object was passed
142 0 ▶ if ( ! defined( $obj ) ){
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $obj) 0 0 0
143 0 $self->{error}=5;
144 0 $self->{errorString}='No object passed';
145 0 $self->warn;
146 0 return $self;
147 }
148  
149 #make sure it is a supported type
150 0 ▶ if ( ref( $obj ) ne 'Toader::Page' ){
Branch: 1 branch
BranchTrueFalseTotal
if (ref $obj ne "Toader::Page") 0 0 0
151 0 $self->{error}=4;
152 0 $self->{errorString}='"'.ref( $obj ).'" is not a supported object type';
153 0 $self->warn;
154 0 return $self;
155 }
156  
157 #make sure a permanent error is not set
158 0 $obj->errorblank;
159 0 ▶ if( $obj->error ){
Branch: 1 branch
BranchTrueFalseTotal
if ($obj->error) 0 0 0
160 0 $self->{error}=8;
161 0 $self->{errorString}='The object error has a permanent error set. error="'
162 .$obj->error.'" errorString="'.$obj->errorString.'"';
163 0 $self->warn;
164 0 return undef;
165 }
166  
167 #gets the directory
168 0 my $dir=$obj->dirGet;
169 0 ▶ if ( ! defined( $dir ) ){
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $dir) 0 0 0
170 0 $self->{error}=9;
171 0 $self->{errorString}='The object has not had a directory set for it';
172 0 $self->warn;
173 0 return undef;
174 }
175  
176 #puts together the base directory
177 0 $dir=$self->{outputdir}.'/'.$self->{pathhelper}->relative2root($dir).'/';
178 0 ▶ if( $self->{pathhelper}->error ){
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"pathhelper"}->error) 0 0 0
179 0 $self->{error}=10;
180 $self->{errorString}='Toader::pathHelper errored. error="'.
181 $self->{pathhelper}->error.'" errorString="'.
182 0 $self->{pathhelper}->errorString.'"';
183 0 $self->warn;
184 0 return undef;
185 }
186 0 $dir=$dir.'.pages/'.$obj->nameGet.'/';
187  
188 #if the directory does not exist, there is nothing to clean up
189 0 ▶ if ( ! -e $dir ){
Branch: 1 branch
BranchTrueFalseTotal
unless (-e $dir) 0 0 0
190 0 return 1;
191 }
192  
193 #a list of files that could not be removed
194 0 my @failed;
195  
196 #tries to remove the index file
197 0 my $index=$dir.'index.html';
198 0 my $indexNotAfile=0;
199 0 ▶ if ( -f $index ){
Branch: 1 branch
BranchTrueFalseTotal
if (-f $index) { } 0 0 0
200 0 ▶ if( ! unlink( $index ) ){
Branch: 1 branch
BranchTrueFalseTotal
unless (unlink $index) 0 0 0
201 0 push( @failed, $index );
202 }
203 }else{
204 0 ▶ if ( -e $index ){
Branch: 1 branch
BranchTrueFalseTotal
if (-e $index) 0 0 0
205 0 $indexNotAfile=1;
206 0 push( @failed, $index );
207 }
208 }
209  
210 #tries to remove the attached files
211 0 my $filesdir=$dir.'.files/';
212 0 my @files;
213 my $dh;
214 0 my $openFilesdirFailed=0;
215 0 ▶ if (! opendir( $dh, $filesdir ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (not opendir($dh, $filesdir)) { } 0 0 0
216 0 ▶ if ( -e $filesdir ){
Branch: 1 branch
BranchTrueFalseTotal
if (-e $filesdir) 0 0 0
217 0 $openFilesdirFailed=0;
218 }
219 }else{
220 0 @files=readdir( $dh );
221 0 closedir( $dh );
222 }
223
224 #removes each file
225 0 my $int=0;
226 0 my $foundAnonFile=0;
227 0 my @nonfiles;
228 0 ▶ while ( defined( $files[$int] ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (defined $files[$int]) 0 0 0
229 0 my $path=$filesdir.$files[$int];
230  
231 #determines if it should be skipped
232 0 my $skip=0;
233  
234 #skips .. or .
235 0 ▶ if (
Branch: 1 branch
BranchTrueFalseTotal
if ($files[$int] eq "." or $files[$int] eq "..") 0 0 0
Condition0%0/3
$files[$int] eq "." or $files[$int] eq ".."
l!l&&r!l&&!r
000
MC/DC0%0/2
$files[$int] eq "." or $files[$int] eq ".."
$files[$int] eq "." $files[$int] eq ".."
Truth table0%0/3
A or B
A= $files[$int] eq "."B= $files[$int] eq ".."
ABresult
1X1
011
000
236 ( $files[$int] eq '.' ) ||
237 ( $files[$int] eq '..' )
238 ){
239 0 $skip=1;
240 }
241  
242 #skip non-files
243 0 ▶ if (
Branch: 1 branch
BranchTrueFalseTotal
unless (-f $path or $skip) 0 0 0
Condition0%0/3
-f $path or $skip
l!l&&r!l&&!r
000
MC/DC0%0/2
-f $path or $skip
-f $path $skip
Truth table0%0/3
A or B
A= -f $pathB= $skip
ABresult
1X1
011
000
244 ( ! -f $path ) &&
245 ( ! $skip )
246 ){
247 0 $skip=1;
248 0 push( @nonfiles, $path );
249 }
250  
251 0 ▶ if ( ! $skip ){
Branch: 1 branch
BranchTrueFalseTotal
unless ($skip) 0 0 0
252 0 ▶ if( ! unlink( $path) ){
Branch: 1 branch
BranchTrueFalseTotal
unless (unlink $path) 0 0 0
253 0 push( @failed, $path );
254 }
255 }
256  
257 0 $int++;
258 }
259  
260 #removes the files directory
261 0 my $fileDirRMfailed=0;
262 0 ▶ if(
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $nonfiles[0] && defined $failed[0] and -e $filesdir) 0 0 0
Condition0%0/6
not defined $nonfiles[0] && defined $failed[0] and -e $filesdir
!ll&&!rl&&r
000
defined $nonfiles[0] && defined $failed[0]
!ll&&!rl&&r
000
MC/DC0%0/3
not defined $nonfiles[0] && defined $failed[0] and -e $filesdir
defined $nonfiles[0] defined $failed[0] -e $filesdir
Truth table0%0/5
not(A && B) and C
A= defined $nonfiles[0]B= defined $failed[0]C= -e $filesdir
ABCresult
11X0
0X00
1000
0X11
1011
263 (
264 ( ! defined( $nonfiles[0] ) ) ||
265 ( ! defined( $failed[0] ) )
266 ) &&
267 ( -e $filesdir )
268 ){
269 0 ▶ if( ! rmdir $filesdir ){
Branch: 1 branch
BranchTrueFalseTotal
unless (rmdir $filesdir) 0 0 0
270 0 $fileDirRMfailed=1;
271 };
272 }
273  
274 #checks to see if the obj directory can be removed and if so remove it
275 0 my $objDirRMfailed=0;
276 0 ▶ if ( ! -e $filesdir ){
Branch: 1 branch
BranchTrueFalseTotal
unless (-e $filesdir) 0 0 0
277 0 ▶ if (! opendir( $dh, $dir ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (not opendir($dh, $dir)) { } 0 0 0
278 0 $openFilesdirFailed=0;
279 }else{
280 0 @files=readdir( $dh );
281 0 closedir( $dh );
282 }
283  
284 0 ▶ if (opendir( $dh, $filesdir ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (opendir $dh, $filesdir) 0 0 0
285 0 @files=readdir( $dh );
286 0 closedir( $dh );
287 }
288
289 0 $int=0;
290 0 my $rmObjDir=1;
291 0 ▶ while ( defined( $files[$int] ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (defined $files[$int]) 0 0 0
292 0 ▶ if (
Branch: 1 branch
BranchTrueFalseTotal
if ($files[$int] ne "." or $files[$int] ne "..") 0 0 0
Condition0%0/3
$files[$int] ne "." or $files[$int] ne ".."
l!l&&r!l&&!r
000
MC/DC0%0/2
$files[$int] ne "." or $files[$int] ne ".."
$files[$int] ne "." $files[$int] ne ".."
Truth table0%0/3
A or B
A= $files[$int] ne "."B= $files[$int] ne ".."
ABresult
1X1
011
000
293 ( $files[$int] ne '.' ) ||
294 ( $files[$int] ne '..' )
295 ){
296 0 $rmObjDir=0;
297 }
298  
299 0 $int++;
300 }
301  
302 0 ▶ if ( $rmObjDir ){
Branch: 1 branch
BranchTrueFalseTotal
if ($rmObjDir) 0 0 0
303 0 ▶ if ( ! rmdir( $dir ) ){
Branch: 1 branch
BranchTrueFalseTotal
unless (rmdir $dir) 0 0 0
304 0 $objDirRMfailed=1;
305 }
306 }
307  
308 }
309  
310 #handles it if it errored
311 0 ▶ if(
Branch: 1 branch
BranchTrueFalseTotal
if (defined $nonfiles[0] or $openFilesdirFailed or $indexNotAfile or $fileDirRMfailed or $objDirRMfailed or defined $failed[0]) 0 0 0
Condition0%0/15
defined $nonfiles[0] or $openFilesdirFailed or $indexNotAfile or $fileDirRMfailed or $objDirRMfailed or defined $failed[0]
l!l&&r!l&&!r
000
defined $nonfiles[0] or $openFilesdirFailed or $indexNotAfile or $fileDirRMfailed or $objDirRMfailed
l!l&&r!l&&!r
000
defined $nonfiles[0] or $openFilesdirFailed or $indexNotAfile or $fileDirRMfailed
l!l&&r!l&&!r
000
defined $nonfiles[0] or $openFilesdirFailed or $indexNotAfile
l!l&&r!l&&!r
000
defined $nonfiles[0] or $openFilesdirFailed
l!l&&r!l&&!r
000
MC/DC0%0/6
defined $nonfiles[0] or $openFilesdirFailed or $indexNotAfile or $fileDirRMfailed or $objDirRMfailed or defined $failed[0]
defined $nonfiles[0] $openFilesdirFailed $indexNotAfile $fileDirRMfailed $objDirRMfailed defined $failed[0]
Truth table0%0/7
A or B or C or D or E or F
A= defined $nonfiles[0]B= $openFilesdirFailedC= $indexNotAfileD= $fileDirRMfailedE= $objDirRMfailedF= defined $failed[0]
ABCDEFresult
1XXXXX1
01XXXX1
001XXX1
0001XX1
00001X1
0000011
0000000
312 defined( $nonfiles[0] )||
313 $openFilesdirFailed ||
314 $indexNotAfile ||
315 $fileDirRMfailed ||
316 $objDirRMfailed ||
317 defined( $failed[0] )
318 ){
319  
320 0 my $error='';
321  
322 0 ▶ if ( $indexNotAfile ){
Branch: 1 branch
BranchTrueFalseTotal
if ($indexNotAfile) 0 0 0
323 0 $error='The index file, "'.$index.'", could not be removed. ';
324 }
325  
326 0 ▶ if ( $openFilesdirFailed ){
Branch: 1 branch
BranchTrueFalseTotal
if ($openFilesdirFailed) 0 0 0
327 0 $error=$error.'Could not open the files directory for reading ';
328 }
329  
330 0 ▶ if ( $fileDirRMfailed ){
Branch: 1 branch
BranchTrueFalseTotal
if ($fileDirRMfailed) 0 0 0
331 0 $error=$error.'Failed to remove the files directory, "'.$filesdir.'". ';
332 }
333  
334 0 ▶ if ( $objDirRMfailed ){
Branch: 1 branch
BranchTrueFalseTotal
if ($objDirRMfailed) 0 0 0
335 0 $error=$error.'Failed to remove the object directory, "'.$dir.'".';
336 }
337  
338 0 my $int=0;
339  
340 0 ▶ if ( defined( $nonfiles[0] ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (defined $nonfiles[0]) 0 0 0
341 0 $error=$error.'Some none files were found... ';
342 0 ▶ while ( defined( $nonfiles[$int] ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (defined $nonfiles[$int]) 0 0 0
343 0 $error=$error.'"'.$nonfiles[$int].'" ';
344  
345 0 $int++;
346 }
347 }
348  
349 0 ▶ if ( defined( $failed[0] ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (defined $failed[0]) 0 0 0
350 0 $error=$error.'Some files could not be removed... ';
351 0 $int=0;
352 0 ▶ while ( defined( $failed[$int] ) ){
Branch: 1 branch
BranchTrueFalseTotal
if (defined $failed[$int]) 0 0 0
353 0 $error=$error.'"'.$failed[$int].'" ';
354  
355 0 $int++;
356 }
357 }
358  
359 0 $self->{error}=11;
360 0 $self->{errorString}=$error;
361 0 $self->warn;
362 0 return undef;
363 }
364  
365 0 return 1;
366 }
367  
368 =head1 ERROR CODES
369  
370 =head2 1, noToaderObj
371  
372 No L<Toader> object passed.
373  
374 =head2 2, notAtoaderObj
375  
376 The passed object is not a L<Toader> object.
377  
378 =head2 3, toaderPerror
379  
380 The L<Toader> object passed has a permanent error set.
381  
382 =head2 4, notApageObj
383  
384 The passed object is not a L<Toader::Page> object.
385  
386 =head2 5, noObj
387  
388 No object passed.
389  
390 =head2 6, noOutputDirSet
391  
392 The L<Toader> object has not had a output directory set.
393  
394 =head2 7, outputDirDoesNotExist
395  
396 The output directory does not appear to exist or is not a directory.
397  
398 =head2 8, objPerror
399  
400 The object has a permanent error set.
401  
402 =head2 9, noDirSet
403  
404 The object has not had a directory set for it.
405  
406 =head2 10, pathhelperErrored
407  
408 L<Toader::pathHelper> errored.
409  
410 =head2 11, cleanupFailed
411  
412 Cleaned errored. See error message.
413  
414 =head1 AUTHOR
415  
416 Zane C. Bowers-Hadley, C<< <vvelox at vvelox.net> >>
417  
418 =head1 BUGS
419  
420 Please report any bugs or feature requests to C<bug-toader at rt.cpan.org>, or through
421 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>. I will be notified, and then you'll
422 automatically be notified of progress on your bug as I make changes.
423  
424  
425  
426  
427 =head1 SUPPORT
428  
429 You can find documentation for this module with the perldoc command.
430  
431 perldoc Toader::Render::Page::Cleanup
432  
433 You can also look for information at:
434  
435 =over 4
436  
437 =item * RT: CPAN's request tracker
438  
439 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>
440  
441 =item * AnnoCPAN: Annotated CPAN documentation
442  
443 L<http://annocpan.org/dist/Toader>
444  
445 =item * CPAN Ratings
446  
447 L<http://cpanratings.perl.org/d/Toader>
448  
449 =item * Search CPAN
450  
451 L<http://search.cpan.org/dist/Toader/>
452  
453 =back
454  
455  
456 =head1 ACKNOWLEDGEMENTS
457  
458  
459 =head1 LICENSE AND COPYRIGHT
460  
461 Copyright 2013. Zane C. Bowers-Hadley.
462  
463 This program is free software; you can redistribute it and/or modify it
464 under the terms of either: the GNU General Public License as published
465 by the Free Software Foundation; or the Artistic License.
466  
467 See http://dev.perl.org/licenses/ for more information.
468  
469 =cut
470  
471 1 1; # End of Toader::Render::Page::Cleanup
« Toader/Render/Entry/Cleanup.pm ↑ Summary Toader/Render/AutoDoc.pm »