2 package IO::Compress::Base ;
9 use IO::Compress::Base::Common 2.048 ;
11 use IO::File qw(SEEK_SET SEEK_END); ;
12 use Scalar::Util qw(blessed readonly);
21 @ISA = qw(Exporter IO::File);
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.
30 ${ *$self->{ErrorNo} } = shift() + 0 ;
31 ${ *$self->{Error} } = '' ;
33 return ${ *$self->{ErrorNo} } ;
41 ${ *$self->{Error} } = shift ;
42 ${ *$self->{ErrorNo} } = shift() + 0 if @_ ;
50 $self->saveErrorString(0, $_[0]);
59 my $errno = *$self->{ErrorNo};
60 my $error = ${ *$self->{Error} };
64 *$self->{ErrorNo} = $errno ;
65 ${ *$self->{Error} } = $error ;
75 return ${ *$self->{Error} } ;
81 return ${ *$self->{ErrorNo} } ;
91 if (defined *$self->{FH}) {
92 my $here = tell(*$self->{FH});
93 return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!)
95 seek(*$self->{FH}, $offset, SEEK_SET)
96 or return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ;
97 defined *$self->{FH}->write($data, length $data)
98 or return $self->saveErrorString(undef, $!, $!) ;
99 seek(*$self->{FH}, $here, SEEK_SET)
100 or return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ;
103 substr(${ *$self->{Buffer} }, $offset, length($data)) = $data ;
113 return $self->output(@_);
124 if length $data == 0 && ! $last ;
126 if ( *$self->{FilterContainer} ) {
128 &{ *$self->{FilterContainer} }();
132 if ( defined *$self->{FH} ) {
133 defined *$self->{FH}->write( $data, length $data )
134 or return $self->saveErrorString(0, $!, $!);
137 ${ *$self->{Buffer} } .= $data ;
146 return ( 'MultiStream' => [1, 1, Parse_boolean, 1],
155 my $got = shift || IO::Compress::Base::Parameters::new();
160 'AutoClose' => [1, 1, Parse_boolean, 0],
161 #'Encode' => [1, 1, Parse_any, undef],
162 'Strict' => [0, 1, Parse_boolean, 1],
163 'Append' => [1, 1, Parse_boolean, 0],
164 'BinModeIn' => [1, 1, Parse_boolean, 0],
166 'FilterContainer' => [1, 1, Parse_code, undef],
168 $self->getExtraParams(),
169 *$self->{OneShot} ? $self->getOneShotParams()
172 @_) or $self->croakError("${class}: $got->{Error}") ;
182 *$obj->{Closed} = 1 ;
184 my $class = ref $obj;
185 $obj->croakError("$class: Missing Output parameter")
188 my $outValue = shift ;
194 $got = $obj->checkParams($class, undef, @_)
198 my $lax = ! $got->value('Strict') ;
200 my $outType = whatIsOutput($outValue);
202 $obj->ckOutputParam($class, $outValue)
205 if ($outType eq 'buffer') {
206 *$obj->{Buffer} = $outValue;
210 *$obj->{Buffer} = \$buff ;
213 # Merge implies Append
214 my $merge = $got->value('Merge') ;
215 my $appendOutput = $got->value('Append') || $merge ;
216 *$obj->{Append} = $appendOutput;
217 *$obj->{FilterContainer} = $got->value('FilterContainer') ;
221 # Switch off Merge mode if output file/buffer is empty/doesn't exist
222 if (($outType eq 'buffer' && length $$outValue == 0 ) ||
223 ($outType ne 'buffer' && (! -e $outValue || (-w _ && -z _))) )
227 # If output is a file, check that it is writable
229 #if ($outType eq 'filename' && -e $outValue && ! -w _)
230 # { return $obj->saveErrorString(undef, "Output file '$outValue' is not writable" ) }
234 if ($got->parsed('Encode')) {
235 my $want_encoding = $got->value('Encode');
236 *$obj->{Encoding} = getEncoding($obj, $class, $want_encoding);
240 or $obj->croakError("${class}: " . $obj->error());
243 $obj->saveStatus(STATUS_OK) ;
248 *$obj->{Compress} = $obj->mkComp($got)
251 *$obj->{UnCompSize} = new U64 ;
252 *$obj->{CompSize} = new U64 ;
254 if ( $outType eq 'buffer') {
255 ${ *$obj->{Buffer} } = ''
256 unless $appendOutput ;
259 if ($outType eq 'handle') {
260 *$obj->{FH} = $outValue ;
261 setBinModeOutput(*$obj->{FH}) ;
263 *$obj->{Handle} = 1 ;
266 seek(*$obj->{FH}, 0, SEEK_END)
267 or return $obj->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ;
271 elsif ($outType eq 'filename') {
276 *$obj->{FH} = new IO::File "$mode $outValue"
277 or return $obj->saveErrorString(undef, "cannot open file '$outValue': $!", $!) ;
278 *$obj->{StdIO} = ($outValue eq '-');
279 setBinModeOutput(*$obj->{FH}) ;
283 *$obj->{Header} = $obj->mkHeader($got) ;
284 $obj->output( *$obj->{Header} )
286 $obj->beforePayload();
290 *$obj->{Compress} = $obj->createMerge($outValue, $outType)
294 *$obj->{Closed} = 0 ;
295 *$obj->{AutoClose} = $got->value('AutoClose') ;
296 *$obj->{Output} = $outValue;
297 *$obj->{ClassName} = $class;
299 *$obj->{OneShot} = 0 ;
308 my $outType = whatIsOutput($_[0]);
310 $self->croakError("$from: output parameter not a filename, filehandle or scalar ref")
313 #$self->croakError("$from: output filename is undef or null string")
314 #if $outType eq 'filename' && (! defined $_[0] || $_[0] eq '') ;
316 $self->croakError("$from: output buffer is read-only")
317 if $outType eq 'buffer' && readonly(${ $_[0] });
327 my $class= (caller)[0] ;
328 my $name = (caller(1))[3] ;
330 $obj->croakError("$name: expected at least 1 parameters\n")
337 my $x = new IO::Compress::Base::Validator($class, *$obj->{Error}, $name, $input, $output)
340 push @_, $output if $haveOut && $x->{Hash};
342 *$obj->{OneShot} = 1 ;
344 my $got = $obj->checkParams($name, undef, @_)
351 # while (my($k, $v) = each %$input)
354 # unless defined $v ;
356 # $obj->_singleTarget($x, 1, $k, $v, @_)
360 # return keys %$input ;
366 foreach my $pair (@{ $x->{Pairs} })
368 my ($from, $to) = @$pair ;
369 $obj->_singleTarget($x, 1, $from, $to, @_)
373 return scalar @{ $x->{Pairs} } ;
376 if (! $x->{oneOutput} )
378 my $inFile = ($x->{inType} eq 'filenames'
379 || $x->{inType} eq 'filename');
381 $x->{inType} = $inFile ? 'filename' : 'buffer';
383 foreach my $in ($x->{oneInput} ? $input : @$input)
388 $obj->_singleTarget($x, $inFile, $in, \$out, @_)
391 push @$output, \$out ;
392 #if ($x->{outType} eq 'array')
393 # { push @$output, \$out }
395 # { $output->{$in} = \$out }
401 # finally the 1 to 1 and n to 1
402 return $obj->_singleTarget($x, 1, $input, $output, @_);
404 Carp::croak "should not be here" ;
411 my $inputIsFilename = shift;
416 $obj->getFileInfo($x->{Got}, $input)
417 if isaScalar($input) || (isaFilename($input) and $inputIsFilename) ;
419 my $z = $obj->_create($x->{Got}, @_)
423 defined $z->_wr2($input, $inputIsFilename)
424 or return $z->closeError(undef) ;
431 my $inputIsFilename = ($x->{inType} ne 'array');
432 my $keep = $x->{Got}->clone();
434 #for my $element ( ($x->{inType} eq 'hash') ? keys %$input : @$input)
435 for my $element ( @$input)
437 my $isFilename = isaFilename($element);
439 if ( $afterFirst ++ )
441 defined addInterStream($obj, $element, $isFilename)
442 or return $obj->closeError(undef) ;
446 $obj->getFileInfo($x->{Got}, $element)
447 if isaScalar($element) || $isFilename;
449 $obj->_create($x->{Got}, @_)
453 defined $obj->_wr2($element, $isFilename)
454 or return $obj->closeError(undef) ;
456 *$obj->{Got} = $keep->clone();
458 return $obj->close() ;
468 my $inputIsFilename = shift;
470 my $input = $source ;
471 if (! $inputIsFilename)
477 if ( ref $input && ref $input eq 'SCALAR' )
479 return $self->syswrite($input, @_) ;
482 if ( ! ref $input || isaFilehandle($input))
484 my $isFilehandle = isaFilehandle($input) ;
488 if ( ! $isFilehandle )
490 $fh = new IO::File "<$input"
491 or return $self->saveErrorString(undef, "cannot open file '$input': $!", $!) ;
493 binmode $fh if *$self->{Got}->valueOrDefault('BinModeIn') ;
498 while ($status = read($fh, $buff, 16 * 1024)) {
499 $count += length $buff;
500 defined $self->syswrite($buff, @_)
504 return $self->saveErrorString(undef, $!, $!)
505 if ! defined $status ;
507 if ( (!$isFilehandle || *$self->{AutoClose}) && $input ne '-')
516 Carp::croak "Should not be here";
524 my $inputIsFilename = shift ;
526 if (*$self->{Got}->value('MultiStream'))
528 $self->getFileInfo(*$self->{Got}, $input)
529 #if isaFilename($input) and $inputIsFilename ;
530 if isaScalar($input) || isaFilename($input) ;
532 # TODO -- newStream needs to allow gzip/zip header to be modified
533 return $self->newStream();
535 elsif (*$self->{Got}->value('AutoFlush'))
537 #return $self->flush(Z_FULL_FLUSH);
549 return $_[0] if ref($_[0]);
561 local ($., $@, $!, $^E, $?);
565 # TODO - memory leak with 5.8.0 - this isn't called until
574 sub filterUncompressed
584 $self->croakError( *$self->{ClassName} . "::write: not a scalar reference" )
585 unless ref $_[0] eq 'SCALAR' ;
592 $] >= 5.008 and ( utf8::downgrade($$buffer, 1)
593 or Carp::croak "Wide character in " . *$self->{ClassName} . "::write:");
597 my $slen = defined $$buffer ? length($$buffer) : 0;
600 $len = $_[1] if $_[1] < $len;
603 $offset = $_[2] || 0;
604 $self->croakError(*$self->{ClassName} . "::write: offset outside string")
608 $self->croakError( *$self->{ClassName} . "::write: offset outside string") if $offset < 0;
610 my $rem = $slen - $offset;
611 $len = $rem if $rem < $len;
614 $buffer = \substr($$buffer, $offset, $len) ;
617 return 0 if ! defined $$buffer || length $$buffer == 0 ;
619 if (*$self->{Encoding}) {
620 $$buffer = *$self->{Encoding}->encode($$buffer);
623 $self->filterUncompressed($buffer);
625 my $buffer_length = defined $$buffer ? length($$buffer) : 0 ;
626 *$self->{UnCompSize}->add($buffer_length) ;
629 my $status = *$self->{Compress}->compr($buffer, $outBuffer) ;
631 return $self->saveErrorString(undef, *$self->{Compress}{Error},
632 *$self->{Compress}{ErrorNo})
633 if $status == STATUS_ERROR;
635 *$self->{CompSize}->add(length $outBuffer) ;
637 $self->outputPayload($outBuffer)
640 return $buffer_length;
648 # $self = *$self{GLOB} ;
653 defined $self->syswrite(join($,, @_) . $\);
655 defined $self->syswrite(join("", @_) . $\);
659 defined $self->syswrite(join($,, @_));
661 defined $self->syswrite(join("", @_));
670 defined $self->syswrite(sprintf($fmt, @_));
680 my $status = *$self->{Compress}->flush($outBuffer, @_) ;
681 return $self->saveErrorString(0, *$self->{Compress}{Error},
682 *$self->{Compress}{ErrorNo})
683 if $status == STATUS_ERROR;
685 if ( defined *$self->{FH} ) {
686 *$self->{FH}->clearerr();
689 *$self->{CompSize}->add(length $outBuffer) ;
691 $self->outputPayload($outBuffer)
694 if ( defined *$self->{FH} ) {
695 defined *$self->{FH}->flush()
696 or return $self->saveErrorString(0, $!, $!);
711 $self->_writeTrailer()
714 $self->ckParams($got)
715 or $self->croakError("newStream: $self->{Error}");
717 *$self->{Compress} = $self->mkComp($got)
720 *$self->{Header} = $self->mkHeader($got) ;
721 $self->output(*$self->{Header} )
724 *$self->{UnCompSize}->reset();
725 *$self->{CompSize}->reset();
727 $self->beforePayload();
736 my $got = $self->checkParams('newStream', *$self->{Got}, @_)
739 $self->_newStream($got);
741 # *$self->{Compress} = $self->mkComp($got)
744 # *$self->{Header} = $self->mkHeader($got) ;
745 # $self->output(*$self->{Header} )
748 # *$self->{UnCompSize}->reset();
749 # *$self->{CompSize}->reset();
751 # $self->beforePayload();
759 return *$self->{Compress}->reset() ;
768 my $status = *$self->{Compress}->close($trailer) ;
769 return $self->saveErrorString(0, *$self->{Compress}{Error}, *$self->{Compress}{ErrorNo})
770 if $status == STATUS_ERROR;
772 *$self->{CompSize}->add(length $trailer) ;
774 $trailer .= $self->mkTrailer();
778 return $self->output($trailer);
781 sub _writeFinalTrailer
785 return $self->output($self->mkFinalTrailer());
792 return 1 if *$self->{Closed} || ! *$self->{Compress} ;
793 *$self->{Closed} = 1 ;
798 $self->_writeTrailer()
801 $self->_writeFinalTrailer()
804 $self->output( "", 1 )
807 if (defined *$self->{FH}) {
809 #if (! *$self->{Handle} || *$self->{AutoClose}) {
810 if ((! *$self->{Handle} || *$self->{AutoClose}) && ! *$self->{StdIO}) {
812 *$self->{FH}->close()
813 or return $self->saveErrorString(0, $!, $!);
815 delete *$self->{FH} ;
816 # This delete can set $! in older Perls, so reset the errno
831 # return *$self->{Compress}->crc32() ;
837 # return *$self->{Compress}->msg() ;
843 # return *$self->{Compress}->dict_adler() ;
849 # return *$self->{Compress}->get_Level() ;
855 # return *$self->{Compress}->get_Strategy() ;
863 return *$self->{UnCompSize}->get32bit() ;
870 return *$self->{Closed} ;
877 my $position = shift;
880 my $here = $self->tell() ;
883 #use IO::Handle qw(SEEK_SET SEEK_CUR SEEK_END);
886 if ($whence == IO::Handle::SEEK_SET) {
887 $target = $position ;
889 elsif ($whence == IO::Handle::SEEK_CUR || $whence == IO::Handle::SEEK_END) {
890 $target = $here + $position ;
893 $self->croakError(*$self->{ClassName} . "::seek: unknown value, $whence, for whence parameter");
896 # short circuit if seeking to current offset
897 return 1 if $target == $here ;
899 # Outlaw any attempt to seek backwards
900 $self->croakError(*$self->{ClassName} . "::seek: cannot seek backwards")
903 # Walk the file to the new offset
904 my $offset = $target - $here ;
907 defined $self->syswrite("\x00" x $offset)
917 # return defined *$self->{FH}
918 # ? binmode *$self->{FH}
925 return defined *$self->{FH}
926 ? *$self->{FH}->fileno()
933 return ! *$self->{Closed} ;
939 return defined *$self->{FH}
940 ? *$self->{FH}->autoflush(@_)
944 sub input_line_number
953 return sub { Carp::croak "$name Not Available: File opened only for output" ; } ;
956 *read = _notAvailable('read');
957 *READ = _notAvailable('read');
958 *readline = _notAvailable('readline');
959 *READLINE = _notAvailable('readline');
960 *getc = _notAvailable('getc');
961 *GETC = _notAvailable('getc');
972 *BINMODE = \&binmode;
974 #*sysread = \&_notAvailable;
975 #*syswrite = \&_write;
983 IO::Compress::Base - Base Class for IO::Compress modules
987 use IO::Compress::Base ;
991 This module is not intended for direct use in application code. Its sole
992 purpose if to to be sub-classed by IO::Compress modules.
996 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::Lzma>, L<IO::Uncompress::UnLzma>, L<IO::Compress::Xz>, L<IO::Uncompress::UnXz>, L<IO::Compress::Lzop>, L<IO::Uncompress::UnLzop>, L<IO::Compress::Lzf>, L<IO::Uncompress::UnLzf>, L<IO::Uncompress::AnyInflate>, L<IO::Uncompress::AnyUncompress>
998 L<IO::Compress::FAQ|IO::Compress::FAQ>
1000 L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>,
1001 L<Archive::Tar|Archive::Tar>,
1002 L<IO::Zlib|IO::Zlib>
1006 This module was written by Paul Marquess, F<pmqs@cpan.org>.
1008 =head1 MODIFICATION HISTORY
1010 See the Changes file.
1012 =head1 COPYRIGHT AND LICENSE
1014 Copyright (c) 2005-2012 Paul Marquess. All rights reserved.
1016 This program is free software; you can redistribute it and/or
1017 modify it under the same terms as Perl itself.