Commit | Line | Data |
25f0751f |
1 | |
2 | package IO::Compress::Base ; |
3 | |
4 | require 5.004 ; |
5 | |
6 | use strict ; |
7 | use warnings; |
8 | |
9 | use IO::Compress::Base::Common; |
10 | |
11 | use IO::File ; |
12 | use Scalar::Util qw(blessed readonly); |
13 | |
14 | #use File::Glob; |
15 | #require Exporter ; |
16 | use Carp ; |
17 | use Symbol; |
18 | use bytes; |
19 | |
20 | our (@ISA, $VERSION, $got_encode); |
21 | #@ISA = qw(Exporter IO::File); |
22 | |
cb7abd7f |
23 | $VERSION = '2.000_10'; |
25f0751f |
24 | |
25 | #Can't locate object method "SWASHNEW" via package "utf8" (perhaps you forgot to load "utf8"?) at .../ext/Compress-Zlib/Gzip/blib/lib/Compress/Zlib/Common.pm line 16. |
26 | |
27 | #$got_encode = 0; |
28 | #eval |
29 | #{ |
30 | # require Encode; |
31 | # Encode->import('encode', 'find_encoding'); |
32 | #}; |
33 | # |
34 | #$got_encode = 1 unless $@; |
35 | |
36 | sub saveStatus |
37 | { |
38 | my $self = shift ; |
39 | ${ *$self->{ErrorNo} } = shift() + 0 ; |
40 | ${ *$self->{Error} } = '' ; |
41 | |
42 | return ${ *$self->{ErrorNo} } ; |
43 | } |
44 | |
45 | |
46 | sub saveErrorString |
47 | { |
48 | my $self = shift ; |
49 | my $retval = shift ; |
50 | ${ *$self->{Error} } = shift ; |
51 | ${ *$self->{ErrorNo} } = shift() + 0 if @_ ; |
52 | |
53 | return $retval; |
54 | } |
55 | |
56 | sub croakError |
57 | { |
58 | my $self = shift ; |
59 | $self->saveErrorString(0, $_[0]); |
60 | croak $_[0]; |
61 | } |
62 | |
63 | sub closeError |
64 | { |
65 | my $self = shift ; |
66 | my $retval = shift ; |
67 | |
68 | my $errno = *$self->{ErrorNo}; |
69 | my $error = ${ *$self->{Error} }; |
70 | |
71 | $self->close(); |
72 | |
73 | *$self->{ErrorNo} = $errno ; |
74 | ${ *$self->{Error} } = $error ; |
75 | |
76 | return $retval; |
77 | } |
78 | |
79 | |
80 | |
81 | sub error |
82 | { |
83 | my $self = shift ; |
84 | return ${ *$self->{Error} } ; |
85 | } |
86 | |
87 | sub errorNo |
88 | { |
89 | my $self = shift ; |
90 | return ${ *$self->{ErrorNo} } ; |
91 | } |
92 | |
93 | |
94 | sub writeAt |
95 | { |
96 | my $self = shift ; |
97 | my $offset = shift; |
98 | my $data = shift; |
99 | |
100 | if (defined *$self->{FH}) { |
101 | my $here = tell(*$self->{FH}); |
102 | return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) |
103 | if $here < 0 ; |
104 | seek(*$self->{FH}, $offset, SEEK_SET) |
105 | or return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ; |
106 | defined *$self->{FH}->write($data, length $data) |
107 | or return $self->saveErrorString(undef, $!, $!) ; |
108 | seek(*$self->{FH}, $here, SEEK_SET) |
109 | or return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ; |
110 | } |
111 | else { |
112 | substr(${ *$self->{Buffer} }, $offset, length($data)) = $data ; |
113 | } |
114 | |
115 | return 1; |
116 | } |
117 | |
118 | sub getOneShotParams |
119 | { |
120 | return ( 'MultiStream' => [1, 1, Parse_boolean, 1], |
121 | ); |
122 | } |
123 | |
124 | sub checkParams |
125 | { |
126 | my $self = shift ; |
127 | my $class = shift ; |
128 | |
129 | my $got = shift || IO::Compress::Base::Parameters::new(); |
130 | |
131 | $got->parse( |
132 | { |
133 | # Generic Parameters |
134 | 'AutoClose' => [1, 1, Parse_boolean, 0], |
135 | #'Encoding' => [1, 1, Parse_any, undef], |
136 | 'Strict' => [0, 1, Parse_boolean, 1], |
137 | 'Append' => [1, 1, Parse_boolean, 0], |
138 | 'BinModeIn' => [1, 1, Parse_boolean, 0], |
139 | |
140 | $self->getExtraParams(), |
141 | *$self->{OneShot} ? $self->getOneShotParams() |
142 | : (), |
143 | }, |
144 | @_) or $self->croakError("${class}: $got->{Error}") ; |
145 | |
146 | return $got ; |
147 | } |
148 | |
149 | sub _create |
150 | { |
151 | my $obj = shift; |
152 | my $got = shift; |
153 | |
154 | *$obj->{Closed} = 1 ; |
155 | |
156 | my $class = ref $obj; |
157 | $obj->croakError("$class: Missing Output parameter") |
158 | if ! @_ && ! $got ; |
159 | |
160 | my $outValue = shift ; |
161 | my $oneShot = 1 ; |
162 | |
163 | if (! $got) |
164 | { |
165 | $oneShot = 0 ; |
166 | $got = $obj->checkParams($class, undef, @_) |
167 | or return undef ; |
168 | } |
169 | |
170 | my $lax = ! $got->value('Strict') ; |
171 | |
172 | my $outType = whatIsOutput($outValue); |
173 | |
174 | $obj->ckOutputParam($class, $outValue) |
175 | or return undef ; |
176 | |
177 | if ($outType eq 'buffer') { |
178 | *$obj->{Buffer} = $outValue; |
179 | } |
180 | else { |
181 | my $buff = "" ; |
182 | *$obj->{Buffer} = \$buff ; |
183 | } |
184 | |
185 | # Merge implies Append |
186 | my $merge = $got->value('Merge') ; |
187 | my $appendOutput = $got->value('Append') || $merge ; |
188 | |
189 | if ($merge) |
190 | { |
191 | # Switch off Merge mode if output file/buffer is empty/doesn't exist |
192 | if (($outType eq 'buffer' && length $$outValue == 0 ) || |
193 | ($outType ne 'buffer' && (! -e $outValue || (-w _ && -z _))) ) |
194 | { $merge = 0 } |
195 | } |
196 | |
197 | # If output is a file, check that it is writable |
198 | if ($outType eq 'filename' && -e $outValue && ! -w _) |
199 | { return $obj->saveErrorString(undef, "Output file '$outValue' is not writable" ) } |
200 | |
201 | elsif ($outType eq 'handle' && ! -w $outValue) |
202 | { return $obj->saveErrorString(undef, "Output filehandle is not writable" ) } |
203 | |
204 | |
205 | # TODO - encoding |
206 | # if ($got->parsed('Encoding')) { |
207 | # $obj->croakError("$class: Encode module needed to use -Encoding") |
208 | # if ! $got_encode; |
209 | # |
210 | # my $want_encoding = $got->value('Encoding'); |
211 | # my $encoding = find_encoding($want_encoding); |
212 | # |
213 | # $obj->croakError("$class: Encoding '$want_encoding' is not available") |
214 | # if ! $encoding; |
215 | # |
216 | # *$obj->{Encoding} = $encoding; |
217 | # } |
218 | |
219 | $obj->ckParams($got) |
220 | or $obj->croakError("${class}: " . $obj->error()); |
221 | |
222 | |
223 | $obj->saveStatus(STATUS_OK) ; |
224 | |
225 | my $status ; |
226 | if (! $merge) |
227 | { |
228 | *$obj->{Compress} = $obj->mkComp($class, $got) |
229 | or return undef; |
230 | |
231 | *$obj->{BytesWritten} = 0 ; |
232 | *$obj->{UnCompSize_32bit} = 0 ; |
233 | |
234 | *$obj->{Header} = $obj->mkHeader($got) ; |
235 | |
236 | if ( $outType eq 'buffer') { |
237 | ${ *$obj->{Buffer} } = '' |
238 | unless $appendOutput ; |
239 | ${ *$obj->{Buffer} } .= *$obj->{Header}; |
240 | } |
241 | else { |
242 | if ($outType eq 'handle') { |
243 | *$obj->{FH} = $outValue ; |
244 | setBinModeOutput(*$obj->{FH}) ; |
245 | $outValue->flush() ; |
246 | *$obj->{Handle} = 1 ; |
247 | if ($appendOutput) |
248 | { |
249 | seek(*$obj->{FH}, 0, SEEK_END) |
250 | or return $obj->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ; |
251 | |
252 | } |
253 | } |
254 | elsif ($outType eq 'filename') { |
255 | my $mode = '>' ; |
256 | $mode = '>>' |
257 | if $appendOutput; |
258 | *$obj->{FH} = new IO::File "$mode $outValue" |
259 | or return $obj->saveErrorString(undef, "cannot open file '$outValue': $!", $!) ; |
260 | *$obj->{StdIO} = ($outValue eq '-'); |
261 | setBinModeOutput(*$obj->{FH}) ; |
262 | } |
263 | |
264 | |
265 | if (length *$obj->{Header}) { |
266 | defined *$obj->{FH}->write(*$obj->{Header}, length(*$obj->{Header})) |
267 | or return $obj->saveErrorString(undef, $!, $!) ; |
268 | } |
269 | } |
270 | } |
271 | else |
272 | { |
273 | *$obj->{Compress} = $obj->createMerge($outValue, $outType) |
274 | or return undef; |
275 | } |
276 | |
277 | *$obj->{Closed} = 0 ; |
278 | *$obj->{AutoClose} = $got->value('AutoClose') ; |
279 | *$obj->{Output} = $outValue; |
280 | *$obj->{ClassName} = $class; |
281 | *$obj->{Got} = $got; |
282 | *$obj->{OneShot} = 0 ; |
283 | |
284 | return $obj ; |
285 | } |
286 | |
287 | sub ckOutputParam |
288 | { |
289 | my $self = shift ; |
290 | my $from = shift ; |
291 | my $outType = whatIsOutput($_[0]); |
292 | |
293 | $self->croakError("$from: output parameter not a filename, filehandle or scalar ref") |
294 | if ! $outType ; |
295 | |
296 | $self->croakError("$from: output filename is undef or null string") |
297 | if $outType eq 'filename' && (! defined $_[0] || $_[0] eq '') ; |
298 | |
299 | $self->croakError("$from: output buffer is read-only") |
300 | if $outType eq 'buffer' && readonly(${ $_[0] }); |
301 | |
302 | return 1; |
303 | } |
304 | |
305 | |
306 | sub _def |
307 | { |
308 | my $obj = shift ; |
309 | |
310 | my $class= (caller)[0] ; |
311 | my $name = (caller(1))[3] ; |
312 | |
313 | $obj->croakError("$name: expected at least 1 parameters\n") |
314 | unless @_ >= 1 ; |
315 | |
316 | my $input = shift ; |
317 | my $haveOut = @_ ; |
318 | my $output = shift ; |
319 | |
320 | my $x = new Validator($class, *$obj->{Error}, $name, $input, $output) |
321 | or return undef ; |
322 | |
323 | push @_, $output if $haveOut && $x->{Hash}; |
324 | |
325 | *$obj->{OneShot} = 1 ; |
326 | |
327 | my $got = $obj->checkParams($name, undef, @_) |
328 | or return undef ; |
329 | |
330 | $x->{Got} = $got ; |
331 | |
332 | # if ($x->{Hash}) |
333 | # { |
334 | # while (my($k, $v) = each %$input) |
335 | # { |
336 | # $v = \$input->{$k} |
337 | # unless defined $v ; |
338 | # |
339 | # $obj->_singleTarget($x, 1, $k, $v, @_) |
340 | # or return undef ; |
341 | # } |
342 | # |
343 | # return keys %$input ; |
344 | # } |
345 | |
346 | if ($x->{GlobMap}) |
347 | { |
348 | $x->{oneInput} = 1 ; |
349 | foreach my $pair (@{ $x->{Pairs} }) |
350 | { |
351 | my ($from, $to) = @$pair ; |
352 | $obj->_singleTarget($x, 1, $from, $to, @_) |
353 | or return undef ; |
354 | } |
355 | |
356 | return scalar @{ $x->{Pairs} } ; |
357 | } |
358 | |
359 | if (! $x->{oneOutput} ) |
360 | { |
361 | my $inFile = ($x->{inType} eq 'filenames' |
362 | || $x->{inType} eq 'filename'); |
363 | |
364 | $x->{inType} = $inFile ? 'filename' : 'buffer'; |
365 | |
366 | foreach my $in ($x->{oneInput} ? $input : @$input) |
367 | { |
368 | my $out ; |
369 | $x->{oneInput} = 1 ; |
370 | |
371 | $obj->_singleTarget($x, $inFile, $in, \$out, @_) |
372 | or return undef ; |
373 | |
374 | push @$output, \$out ; |
375 | #if ($x->{outType} eq 'array') |
376 | # { push @$output, \$out } |
377 | #else |
378 | # { $output->{$in} = \$out } |
379 | } |
380 | |
381 | return 1 ; |
382 | } |
383 | |
384 | # finally the 1 to 1 and n to 1 |
385 | return $obj->_singleTarget($x, 1, $input, $output, @_); |
386 | |
387 | croak "should not be here" ; |
388 | } |
389 | |
390 | sub _singleTarget |
391 | { |
392 | my $obj = shift ; |
393 | my $x = shift ; |
394 | my $inputIsFilename = shift; |
395 | my $input = shift; |
396 | |
397 | if ($x->{oneInput}) |
398 | { |
399 | $obj->getFileInfo($x->{Got}, $input) |
400 | if isaFilename($input) and $inputIsFilename ; |
401 | |
402 | my $z = $obj->_create($x->{Got}, @_) |
403 | or return undef ; |
404 | |
405 | |
406 | defined $z->_wr2($input, $inputIsFilename) |
407 | or return $z->closeError(undef) ; |
408 | |
409 | return $z->close() ; |
410 | } |
411 | else |
412 | { |
413 | my $afterFirst = 0 ; |
414 | my $inputIsFilename = ($x->{inType} ne 'array'); |
415 | my $keep = $x->{Got}->clone(); |
416 | |
417 | #for my $element ( ($x->{inType} eq 'hash') ? keys %$input : @$input) |
418 | for my $element ( @$input) |
419 | { |
420 | my $isFilename = isaFilename($element); |
421 | |
422 | if ( $afterFirst ++ ) |
423 | { |
424 | defined addInterStream($obj, $element, $isFilename) |
425 | or return $obj->closeError(undef) ; |
426 | } |
427 | else |
428 | { |
429 | $obj->getFileInfo($x->{Got}, $element) |
430 | if $isFilename; |
431 | |
432 | $obj->_create($x->{Got}, @_) |
433 | or return undef ; |
434 | } |
435 | |
436 | defined $obj->_wr2($element, $isFilename) |
437 | or return $obj->closeError(undef) ; |
438 | |
439 | *$obj->{Got} = $keep->clone(); |
440 | } |
441 | return $obj->close() ; |
442 | } |
443 | |
444 | } |
445 | |
446 | sub _wr2 |
447 | { |
448 | my $self = shift ; |
449 | |
450 | my $source = shift ; |
451 | my $inputIsFilename = shift; |
452 | |
453 | my $input = $source ; |
454 | if (! $inputIsFilename) |
455 | { |
456 | $input = \$source |
457 | if ! ref $source; |
458 | } |
459 | |
460 | if ( ref $input && ref $input eq 'SCALAR' ) |
461 | { |
462 | return $self->syswrite($input, @_) ; |
463 | } |
464 | |
465 | if ( ! ref $input || isaFilehandle($input)) |
466 | { |
467 | my $isFilehandle = isaFilehandle($input) ; |
468 | |
469 | my $fh = $input ; |
470 | |
471 | if ( ! $isFilehandle ) |
472 | { |
473 | $fh = new IO::File "<$input" |
474 | or return $self->saveErrorString(undef, "cannot open file '$input': $!", $!) ; |
475 | } |
476 | binmode $fh if *$self->{Got}->valueOrDefault('BinModeIn') ; |
477 | |
478 | my $status ; |
479 | my $buff ; |
480 | my $count = 0 ; |
481 | while (($status = read($fh, $buff, 4096)) > 0) { |
482 | $count += length $buff; |
483 | defined $self->syswrite($buff, @_) |
484 | or return undef ; |
485 | } |
486 | |
487 | return $self->saveErrorString(undef, $!, $!) |
488 | if $status < 0 ; |
489 | |
490 | if ( (!$isFilehandle || *$self->{AutoClose}) && $input ne '-') |
491 | { |
492 | $fh->close() |
493 | or return undef ; |
494 | } |
495 | |
496 | return $count ; |
497 | } |
498 | |
499 | croak "Should not be here"; |
500 | return undef; |
501 | } |
502 | |
503 | sub addInterStream |
504 | { |
505 | my $self = shift ; |
506 | my $input = shift ; |
507 | my $inputIsFilename = shift ; |
508 | |
509 | if (*$self->{Got}->value('MultiStream')) |
510 | { |
511 | $self->getFileInfo(*$self->{Got}, $input) |
512 | #if isaFilename($input) and $inputIsFilename ; |
513 | if isaFilename($input) ; |
514 | |
515 | # TODO -- newStream needs to allow gzip/zip header to be modified |
516 | return $self->newStream(); |
517 | } |
518 | elsif (*$self->{Got}->value('AutoFlush')) |
519 | { |
520 | #return $self->flush(Z_FULL_FLUSH); |
521 | } |
522 | |
523 | return 1 ; |
524 | } |
525 | |
526 | sub TIEHANDLE |
527 | { |
528 | return $_[0] if ref($_[0]); |
529 | die "OOPS\n" ; |
530 | } |
531 | |
532 | sub UNTIE |
533 | { |
534 | my $self = shift ; |
535 | } |
536 | |
537 | sub DESTROY |
538 | { |
539 | my $self = shift ; |
540 | $self->close() ; |
541 | |
542 | # TODO - memory leak with 5.8.0 - this isn't called until |
543 | # global destruction |
544 | # |
545 | %{ *$self } = () ; |
546 | undef $self ; |
547 | } |
548 | |
549 | |
550 | |
551 | sub syswrite |
552 | { |
553 | my $self = shift ; |
554 | |
555 | my $buffer ; |
556 | if (ref $_[0] ) { |
557 | $self->croakError( *$self->{ClassName} . "::write: not a scalar reference" ) |
558 | unless ref $_[0] eq 'SCALAR' ; |
559 | $buffer = $_[0] ; |
560 | } |
561 | else { |
562 | $buffer = \$_[0] ; |
563 | } |
564 | |
565 | |
566 | if (@_ > 1) { |
567 | my $slen = defined $$buffer ? length($$buffer) : 0; |
568 | my $len = $slen; |
569 | my $offset = 0; |
570 | $len = $_[1] if $_[1] < $len; |
571 | |
572 | if (@_ > 2) { |
573 | $offset = $_[2] || 0; |
574 | $self->croakError(*$self->{ClassName} . "::write: offset outside string") |
575 | if $offset > $slen; |
576 | if ($offset < 0) { |
577 | $offset += $slen; |
578 | $self->croakError( *$self->{ClassName} . "::write: offset outside string") if $offset < 0; |
579 | } |
580 | my $rem = $slen - $offset; |
581 | $len = $rem if $rem < $len; |
582 | } |
583 | |
584 | $buffer = \substr($$buffer, $offset, $len) ; |
585 | } |
586 | |
587 | return 0 if ! defined $$buffer || length $$buffer == 0 ; |
588 | |
589 | my $buffer_length = defined $$buffer ? length($$buffer) : 0 ; |
590 | *$self->{BytesWritten} += $buffer_length ; |
591 | my $rest = 0xFFFFFFFF - *$self->{UnCompSize_32bit} ; |
592 | if ($buffer_length > $rest) { |
593 | *$self->{UnCompSize_32bit} = $buffer_length - $rest - 1; |
594 | } |
595 | else { |
596 | *$self->{UnCompSize_32bit} += $buffer_length ; |
597 | } |
598 | |
599 | # if (*$self->{Encoding}) { |
600 | # $$buffer = *$self->{Encoding}->encode($$buffer); |
601 | # } |
602 | |
603 | #my $length = length $$buffer; |
604 | |
605 | my $status = *$self->{Compress}->compr($buffer, *$self->{Buffer}) ; |
606 | |
607 | return $self->saveErrorString(undef, *$self->{Compress}{Error}, |
608 | *$self->{Compress}{ErrorNo}) |
609 | if $status == STATUS_ERROR; |
610 | |
611 | |
612 | if ( defined *$self->{FH} and length ${ *$self->{Buffer} }) { |
613 | defined *$self->{FH}->write( ${ *$self->{Buffer} }, length ${ *$self->{Buffer} } ) |
614 | or return $self->saveErrorString(undef, $!, $!); |
615 | ${ *$self->{Buffer} } = '' ; |
616 | } |
617 | |
618 | return $buffer_length; |
619 | } |
620 | |
621 | sub print |
622 | { |
623 | my $self = shift; |
624 | |
625 | #if (ref $self) { |
626 | # $self = *$self{GLOB} ; |
627 | #} |
628 | |
629 | if (defined $\) { |
630 | if (defined $,) { |
631 | defined $self->syswrite(join($,, @_) . $\); |
632 | } else { |
633 | defined $self->syswrite(join("", @_) . $\); |
634 | } |
635 | } else { |
636 | if (defined $,) { |
637 | defined $self->syswrite(join($,, @_)); |
638 | } else { |
639 | defined $self->syswrite(join("", @_)); |
640 | } |
641 | } |
642 | } |
643 | |
644 | sub printf |
645 | { |
646 | my $self = shift; |
647 | my $fmt = shift; |
648 | defined $self->syswrite(sprintf($fmt, @_)); |
649 | } |
650 | |
651 | |
652 | |
653 | sub flush |
654 | { |
655 | my $self = shift ; |
656 | |
657 | my $status = *$self->{Compress}->flush(*$self->{Buffer}, @_) ; |
658 | return $self->saveErrorString(0, *$self->{Compress}{Error}, |
659 | *$self->{Compress}{ErrorNo}) |
660 | if $status == STATUS_ERROR; |
661 | |
662 | if ( defined *$self->{FH} ) { |
663 | *$self->{FH}->clearerr(); |
664 | defined *$self->{FH}->write(${ *$self->{Buffer} }, length ${ *$self->{Buffer} }) |
665 | or return $self->saveErrorString(0, $!, $!); |
666 | defined *$self->{FH}->flush() |
667 | or return $self->saveErrorString(0, $!, $!); |
668 | ${ *$self->{Buffer} } = '' ; |
669 | } |
670 | |
671 | return 1; |
672 | } |
673 | |
674 | sub newStream |
675 | { |
676 | my $self = shift ; |
677 | |
678 | $self->_writeTrailer() |
679 | or return 0 ; |
680 | |
681 | my $got = $self->checkParams('newStream', *$self->{Got}, @_) |
682 | or return 0 ; |
683 | |
684 | $self->ckParams($got) |
685 | or $self->croakError("newStream: $self->{Error}"); |
686 | |
687 | *$self->{Header} = $self->mkHeader($got) ; |
688 | ${ *$self->{Buffer} } .= *$self->{Header} ; |
689 | |
690 | if (defined *$self->{FH}) |
691 | { |
692 | defined *$self->{FH}->write(${ *$self->{Buffer} }, |
693 | length ${ *$self->{Buffer} }) |
694 | or return $self->saveErrorString(0, $!, $!); |
695 | ${ *$self->{Buffer} } = '' ; |
696 | } |
697 | |
698 | my $status = *$self->{Compress}->reset() ; |
699 | return $self->saveErrorString(0, *$self->{Compress}{Error}, |
700 | *$self->{Compress}{ErrorNo}) |
701 | if $status == STATUS_ERROR; |
702 | |
703 | *$self->{BytesWritten} = 0 ; |
704 | *$self->{UnCompSize_32bit} = 0 ; |
705 | |
706 | return 1 ; |
707 | } |
708 | |
709 | sub _writeTrailer |
710 | { |
711 | my $self = shift ; |
712 | |
713 | my $status = *$self->{Compress}->close(*$self->{Buffer}) ; |
714 | return $self->saveErrorString(0, *$self->{Compress}{Error}, *$self->{Compress}{ErrorNo}) |
715 | if $status == STATUS_ERROR; |
716 | |
717 | my $trailer = $self->mkTrailer(); |
718 | defined $trailer |
719 | or return 0; |
720 | |
721 | ${ *$self->{Buffer} } .= $trailer; |
722 | |
723 | return 1 if ! defined *$self->{FH} ; |
724 | |
725 | defined *$self->{FH}->write(${ *$self->{Buffer} }, length ${ *$self->{Buffer} }) |
726 | or return $self->saveErrorString(0, $!, $!); |
727 | |
728 | ${ *$self->{Buffer} } = '' ; |
729 | |
730 | return 1; |
731 | } |
732 | |
733 | sub _writeFinalTrailer |
734 | { |
735 | my $self = shift ; |
736 | |
737 | ${ *$self->{Buffer} } .= $self->mkFinalTrailer(); |
738 | |
739 | return 1 if ! defined *$self->{FH} ; |
740 | |
741 | defined *$self->{FH}->write(${ *$self->{Buffer} }, length ${ *$self->{Buffer} }) |
742 | or return $self->saveErrorString(0, $!, $!); |
743 | |
744 | ${ *$self->{Buffer} } = '' ; |
745 | |
746 | return 1; |
747 | } |
748 | |
749 | sub close |
750 | { |
751 | my $self = shift ; |
752 | |
753 | return 1 if *$self->{Closed} || ! *$self->{Compress} ; |
754 | *$self->{Closed} = 1 ; |
755 | |
756 | untie *$self |
757 | if $] >= 5.008 ; |
758 | |
759 | $self->_writeTrailer() |
760 | or return 0 ; |
761 | |
762 | $self->_writeFinalTrailer() |
763 | or return 0 ; |
764 | |
765 | if (defined *$self->{FH}) { |
766 | #if (! *$self->{Handle} || *$self->{AutoClose}) { |
767 | if ((! *$self->{Handle} || *$self->{AutoClose}) && ! *$self->{StdIO}) { |
768 | $! = 0 ; |
769 | *$self->{FH}->close() |
770 | or return $self->saveErrorString(0, $!, $!); |
771 | } |
772 | delete *$self->{FH} ; |
773 | # This delete can set $! in older Perls, so reset the errno |
774 | $! = 0 ; |
775 | } |
776 | |
777 | return 1; |
778 | } |
779 | |
780 | |
781 | #sub total_in |
782 | #sub total_out |
783 | #sub msg |
784 | # |
785 | #sub crc |
786 | #{ |
787 | # my $self = shift ; |
788 | # return *$self->{Compress}->crc32() ; |
789 | #} |
790 | # |
791 | #sub msg |
792 | #{ |
793 | # my $self = shift ; |
794 | # return *$self->{Compress}->msg() ; |
795 | #} |
796 | # |
797 | #sub dict_adler |
798 | #{ |
799 | # my $self = shift ; |
800 | # return *$self->{Compress}->dict_adler() ; |
801 | #} |
802 | # |
803 | #sub get_Level |
804 | #{ |
805 | # my $self = shift ; |
806 | # return *$self->{Compress}->get_Level() ; |
807 | #} |
808 | # |
809 | #sub get_Strategy |
810 | #{ |
811 | # my $self = shift ; |
812 | # return *$self->{Compress}->get_Strategy() ; |
813 | #} |
814 | |
815 | |
816 | sub tell |
817 | { |
818 | my $self = shift ; |
819 | |
820 | return *$self->{BytesWritten} ; |
821 | } |
822 | |
823 | sub eof |
824 | { |
825 | my $self = shift ; |
826 | |
827 | return *$self->{Closed} ; |
828 | } |
829 | |
830 | |
831 | sub seek |
832 | { |
833 | my $self = shift ; |
834 | my $position = shift; |
835 | my $whence = shift ; |
836 | |
837 | my $here = $self->tell() ; |
838 | my $target = 0 ; |
839 | |
840 | #use IO::Handle qw(SEEK_SET SEEK_CUR SEEK_END); |
841 | use IO::Handle ; |
842 | |
843 | if ($whence == IO::Handle::SEEK_SET) { |
844 | $target = $position ; |
845 | } |
846 | elsif ($whence == IO::Handle::SEEK_CUR || $whence == IO::Handle::SEEK_END) { |
847 | $target = $here + $position ; |
848 | } |
849 | else { |
850 | $self->croakError(*$self->{ClassName} . "::seek: unknown value, $whence, for whence parameter"); |
851 | } |
852 | |
853 | # short circuit if seeking to current offset |
854 | return 1 if $target == $here ; |
855 | |
856 | # Outlaw any attempt to seek backwards |
857 | $self->croakError(*$self->{ClassName} . "::seek: cannot seek backwards") |
858 | if $target < $here ; |
859 | |
860 | # Walk the file to the new offset |
861 | my $offset = $target - $here ; |
862 | |
863 | my $buffer ; |
864 | defined $self->syswrite("\x00" x $offset) |
865 | or return 0; |
866 | |
867 | return 1 ; |
868 | } |
869 | |
870 | sub binmode |
871 | { |
872 | 1; |
873 | # my $self = shift ; |
874 | # return defined *$self->{FH} |
875 | # ? binmode *$self->{FH} |
876 | # : 1 ; |
877 | } |
878 | |
879 | sub fileno |
880 | { |
881 | my $self = shift ; |
882 | return defined *$self->{FH} |
883 | ? *$self->{FH}->fileno() |
884 | : undef ; |
885 | } |
886 | |
887 | sub opened |
888 | { |
889 | my $self = shift ; |
890 | return ! *$self->{Closed} ; |
891 | } |
892 | |
893 | sub autoflush |
894 | { |
895 | my $self = shift ; |
896 | return defined *$self->{FH} |
897 | ? *$self->{FH}->autoflush(@_) |
898 | : undef ; |
899 | } |
900 | |
901 | sub input_line_number |
902 | { |
903 | return undef ; |
904 | } |
905 | |
906 | |
907 | sub _notAvailable |
908 | { |
909 | my $name = shift ; |
910 | return sub { croak "$name Not Available: File opened only for output" ; } ; |
911 | } |
912 | |
913 | *read = _notAvailable('read'); |
914 | *READ = _notAvailable('read'); |
915 | *readline = _notAvailable('readline'); |
916 | *READLINE = _notAvailable('readline'); |
917 | *getc = _notAvailable('getc'); |
918 | *GETC = _notAvailable('getc'); |
919 | |
920 | *FILENO = \&fileno; |
921 | *PRINT = \&print; |
922 | *PRINTF = \&printf; |
923 | *WRITE = \&syswrite; |
924 | *write = \&syswrite; |
925 | *SEEK = \&seek; |
926 | *TELL = \&tell; |
927 | *EOF = \&eof; |
928 | *CLOSE = \&close; |
929 | *BINMODE = \&binmode; |
930 | |
931 | #*sysread = \&_notAvailable; |
932 | #*syswrite = \&_write; |
933 | |
934 | 1; |
935 | |
936 | __END__ |
937 | |
938 | =head1 NAME |
939 | |
940 | |
941 | IO::Compress::Base - Base Class for IO::Compress modules |
942 | |
943 | |
944 | =head1 SYNOPSIS |
945 | |
946 | use IO::Compress::Base ; |
947 | |
948 | =head1 DESCRIPTION |
949 | |
950 | |
951 | This module is not intended for direct use in application code. Its sole |
952 | purpose if to to be sub-classed by IO::Compress modules. |
953 | |
954 | |
955 | |
956 | |
957 | =head1 SEE ALSO |
958 | |
959 | L<Compress::Zlib>, L<IO::Compress::Gzip>, L<IO::Uncompress::Gunzip>, L<IO::Compress::Deflate>, L<IO::Uncompress::Inflate>, L<IO::Compress::RawDeflate>, L<IO::Uncompress::RawInflate>, L<IO::Compress::Bzip2>, L<IO::Uncompress::Bunzip2>, L<IO::Compress::Lzop>, L<IO::Uncompress::UnLzop>, L<IO::Uncompress::AnyInflate>, L<IO::Uncompress::AnyUncompress> |
960 | |
961 | L<Compress::Zlib::FAQ|Compress::Zlib::FAQ> |
962 | |
963 | L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>, |
964 | L<Archive::Tar|Archive::Tar>, |
965 | L<IO::Zlib|IO::Zlib> |
966 | |
967 | |
968 | |
969 | |
970 | |
25f0751f |
971 | =head1 AUTHOR |
972 | |
cb7abd7f |
973 | This module was written by Paul Marquess, F<pmqs@cpan.org>. |
25f0751f |
974 | |
975 | |
976 | |
977 | =head1 MODIFICATION HISTORY |
978 | |
979 | See the Changes file. |
980 | |
981 | =head1 COPYRIGHT AND LICENSE |
25f0751f |
982 | |
983 | Copyright (c) 2005-2006 Paul Marquess. All rights reserved. |
984 | |
985 | This program is free software; you can redistribute it and/or |
986 | modify it under the same terms as Perl itself. |
987 | |
988 | |