2 package IO::Compress::Base ;
9 use Compress::Zlib::Common;
10 use Compress::Zlib::ParseParameters;
13 use Scalar::Util qw(blessed readonly);
21 our (@ISA, $VERSION, $got_encode);
22 @ISA = qw(Exporter IO::File);
24 $VERSION = '2.000_05';
26 #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.
32 # Encode->import('encode', 'find_encoding');
35 #$got_encode = 1 unless $@;
40 ${ *$self->{ErrorNo} } = shift() + 0 ;
41 ${ *$self->{Error} } = '' ;
43 return ${ *$self->{ErrorNo} } ;
51 ${ *$self->{Error} } = shift ;
52 ${ *$self->{ErrorNo} } = shift() + 0 if @_ ;
60 $self->saveErrorString(0, $_[0]);
69 my $errno = *$self->{ErrorNo};
70 my $error = ${ *$self->{Error} };
74 *$self->{ErrorNo} = $errno ;
75 ${ *$self->{Error} } = $error ;
85 return ${ *$self->{Error} } ;
91 return ${ *$self->{ErrorNo} } ;
101 if (defined *$self->{FH}) {
102 my $here = tell(*$self->{FH});
103 return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!)
105 seek(*$self->{FH}, $offset, SEEK_SET)
106 or return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ;
107 defined *$self->{FH}->write($data, length $data)
108 or return $self->saveErrorString(undef, $!, $!) ;
109 seek(*$self->{FH}, $here, SEEK_SET)
110 or return $self->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ;
113 substr(${ *$self->{Buffer} }, $offset, length($data)) = $data ;
121 return ( 'MultiStream' => [1, 1, Parse_boolean, 1],
130 my $got = shift || Compress::Zlib::ParseParameters::new();
135 'AutoClose' => [1, 1, Parse_boolean, 0],
136 #'Encoding' => [1, 1, Parse_any, undef],
137 'Strict' => [0, 1, Parse_boolean, 1],
138 'Append' => [1, 1, Parse_boolean, 0],
139 'BinModeIn' => [1, 1, Parse_boolean, 0],
141 $self->getExtraParams(),
142 *$self->{OneShot} ? $self->getOneShotParams()
145 @_) or $self->croakError("${class}: $got->{Error}") ;
155 *$obj->{Closed} = 1 ;
157 my $class = ref $obj;
158 $obj->croakError("$class: Missing Output parameter")
161 my $outValue = shift ;
167 $got = $obj->checkParams($class, undef, @_)
171 my $lax = ! $got->value('Strict') ;
173 my $outType = whatIsOutput($outValue);
175 $obj->ckOutputParam($class, $outValue)
178 if ($outType eq 'buffer') {
179 *$obj->{Buffer} = $outValue;
183 *$obj->{Buffer} = \$buff ;
186 # Merge implies Append
187 my $merge = $got->value('Merge') ;
188 my $appendOutput = $got->value('Append') || $merge ;
192 # Switch off Merge mode if output file/buffer is empty/doesn't exist
193 if (($outType eq 'buffer' && length $$outValue == 0 ) ||
194 ($outType ne 'buffer' && (! -e $outValue || (-w _ && -z _))) )
198 # If output is a file, check that it is writable
199 if ($outType eq 'filename' && -e $outValue && ! -w _)
200 { return $obj->saveErrorString(undef, "Output file '$outValue' is not writable" ) }
202 elsif ($outType eq 'handle' && ! -w $outValue)
203 { return $obj->saveErrorString(undef, "Output filehandle is not writable" ) }
207 # if ($got->parsed('Encoding')) {
208 # $obj->croakError("$class: Encode module needed to use -Encoding")
211 # my $want_encoding = $got->value('Encoding');
212 # my $encoding = find_encoding($want_encoding);
214 # $obj->croakError("$class: Encoding '$want_encoding' is not available")
217 # *$obj->{Encoding} = $encoding;
221 or $obj->croakError("${class}: " . $obj->error());
224 $obj->saveStatus(STATUS_OK) ;
229 *$obj->{Compress} = $obj->mkComp($class, $got)
232 *$obj->{BytesWritten} = 0 ;
233 *$obj->{UnCompSize_32bit} = 0 ;
235 *$obj->{Header} = $obj->mkHeader($got) ;
237 if ( $outType eq 'buffer') {
238 ${ *$obj->{Buffer} } = ''
239 unless $appendOutput ;
240 ${ *$obj->{Buffer} } .= *$obj->{Header};
243 if ($outType eq 'handle') {
244 *$obj->{FH} = $outValue ;
245 setBinModeOutput(*$obj->{FH}) ;
247 *$obj->{Handle} = 1 ;
250 seek(*$obj->{FH}, 0, SEEK_END)
251 or return $obj->saveErrorString(undef, "Cannot seek to end of output filehandle: $!", $!) ;
255 elsif ($outType eq 'filename') {
259 *$obj->{FH} = new IO::File "$mode $outValue"
260 or return $obj->saveErrorString(undef, "cannot open file '$outValue': $!", $!) ;
261 *$obj->{StdIO} = ($outValue eq '-');
262 setBinModeOutput(*$obj->{FH}) ;
266 if (length *$obj->{Header}) {
267 defined *$obj->{FH}->write(*$obj->{Header}, length(*$obj->{Header}))
268 or return $obj->saveErrorString(undef, $!, $!) ;
274 *$obj->{Compress} = $obj->createMerge($outValue, $outType)
278 *$obj->{Closed} = 0 ;
279 *$obj->{AutoClose} = $got->value('AutoClose') ;
280 *$obj->{Output} = $outValue;
281 *$obj->{ClassName} = $class;
283 *$obj->{OneShot} = 0 ;
292 my $outType = whatIsOutput($_[0]);
294 $self->croakError("$from: output parameter not a filename, filehandle or scalar ref")
297 $self->croakError("$from: output filename is undef or null string")
298 if $outType eq 'filename' && (! defined $_[0] || $_[0] eq '') ;
300 $self->croakError("$from: output buffer is read-only")
301 if $outType eq 'buffer' && readonly(${ $_[0] });
311 my $class= (caller)[0] ;
312 my $name = (caller(1))[3] ;
314 $obj->croakError("$name: expected at least 1 parameters\n")
321 my $x = new Validator($class, *$obj->{Error}, $name, $input, $output)
324 push @_, $output if $haveOut && $x->{Hash};
326 *$obj->{OneShot} = 1 ;
328 my $got = $obj->checkParams($name, undef, @_)
335 # while (my($k, $v) = each %$input)
338 # unless defined $v ;
340 # $obj->_singleTarget($x, 1, $k, $v, @_)
344 # return keys %$input ;
350 foreach my $pair (@{ $x->{Pairs} })
352 my ($from, $to) = @$pair ;
353 $obj->_singleTarget($x, 1, $from, $to, @_)
357 return scalar @{ $x->{Pairs} } ;
360 if (! $x->{oneOutput} )
362 my $inFile = ($x->{inType} eq 'filenames'
363 || $x->{inType} eq 'filename');
365 $x->{inType} = $inFile ? 'filename' : 'buffer';
367 foreach my $in ($x->{oneInput} ? $input : @$input)
372 $obj->_singleTarget($x, $inFile, $in, \$out, @_)
375 push @$output, \$out ;
376 #if ($x->{outType} eq 'array')
377 # { push @$output, \$out }
379 # { $output->{$in} = \$out }
385 # finally the 1 to 1 and n to 1
386 return $obj->_singleTarget($x, 1, $input, $output, @_);
388 croak "should not be here" ;
395 my $inputIsFilename = shift;
400 $obj->getFileInfo($x->{Got}, $input)
401 if isaFilename($input) and $inputIsFilename ;
403 my $z = $obj->_create($x->{Got}, @_)
407 defined $z->_wr2($input, $inputIsFilename)
408 or return $z->closeError(undef) ;
415 my $inputIsFilename = ($x->{inType} ne 'array');
416 my $keep = $x->{Got}->clone();
418 #for my $element ( ($x->{inType} eq 'hash') ? keys %$input : @$input)
419 for my $element ( @$input)
421 my $isFilename = isaFilename($element);
423 if ( $afterFirst ++ )
425 defined addInterStream($obj, $element, $isFilename)
426 or return $obj->closeError(undef) ;
430 $obj->getFileInfo($x->{Got}, $element)
433 $obj->_create($x->{Got}, @_)
437 defined $obj->_wr2($element, $isFilename)
438 or return $obj->closeError(undef) ;
440 *$obj->{Got} = $keep->clone();
442 return $obj->close() ;
452 my $inputIsFilename = shift;
454 my $input = $source ;
455 if (! $inputIsFilename)
461 if ( ref $input && ref $input eq 'SCALAR' )
463 return $self->syswrite($input, @_) ;
466 if ( ! ref $input || isaFilehandle($input))
468 my $isFilehandle = isaFilehandle($input) ;
472 if ( ! $isFilehandle )
474 $fh = new IO::File "<$input"
475 or return $self->saveErrorString(undef, "cannot open file '$input': $!", $!) ;
477 binmode $fh if *$self->{Got}->valueOrDefault('BinModeIn') ;
482 while (($status = read($fh, $buff, 4096)) > 0) {
483 $count += length $buff;
484 defined $self->syswrite($buff, @_)
488 return $self->saveErrorString(undef, $!, $!)
491 if ( (!$isFilehandle || *$self->{AutoClose}) && $input ne '-')
500 croak "Should not be here";
508 my $inputIsFilename = shift ;
510 if (*$self->{Got}->value('MultiStream'))
512 $self->getFileInfo(*$self->{Got}, $input)
513 #if isaFilename($input) and $inputIsFilename ;
514 if isaFilename($input) ;
516 # TODO -- newStream needs to allow gzip/zip header to be modified
517 return $self->newStream();
519 elsif (*$self->{Got}->value('AutoFlush'))
521 #return $self->flush(Z_FULL_FLUSH);
529 return $_[0] if ref($_[0]);
543 # TODO - memory leak with 5.8.0 - this isn't called until
558 $self->croakError( *$self->{ClassName} . "::write: not a scalar reference" )
559 unless ref $_[0] eq 'SCALAR' ;
568 my $slen = defined $$buffer ? length($$buffer) : 0;
571 $len = $_[1] if $_[1] < $len;
574 $offset = $_[2] || 0;
575 $self->croakError(*$self->{ClassName} . "::write: offset outside string")
579 $self->croakError( *$self->{ClassName} . "::write: offset outside string") if $offset < 0;
581 my $rem = $slen - $offset;
582 $len = $rem if $rem < $len;
585 $buffer = \substr($$buffer, $offset, $len) ;
588 return 0 if ! defined $$buffer || length $$buffer == 0 ;
590 my $buffer_length = defined $$buffer ? length($$buffer) : 0 ;
591 *$self->{BytesWritten} += $buffer_length ;
592 my $rest = 0xFFFFFFFF - *$self->{UnCompSize_32bit} ;
593 if ($buffer_length > $rest) {
594 *$self->{UnCompSize_32bit} = $buffer_length - $rest - 1;
597 *$self->{UnCompSize_32bit} += $buffer_length ;
600 # if (*$self->{Encoding}) {
601 # $$buffer = *$self->{Encoding}->encode($$buffer);
604 #my $length = length $$buffer;
605 my $status = *$self->{Compress}->compr($buffer, *$self->{Buffer}) ;
607 return $self->saveErrorString(undef, *$self->{Compress}{Error},
608 *$self->{Compress}{ErrorNo})
609 if $status == STATUS_ERROR;
613 if ( defined *$self->{FH} and length ${ *$self->{Buffer} }) {
614 defined *$self->{FH}->write( ${ *$self->{Buffer} }, length ${ *$self->{Buffer} } )
615 or return $self->saveErrorString(undef, $!, $!);
616 ${ *$self->{Buffer} } = '' ;
619 return $buffer_length;
627 # $self = *$self{GLOB} ;
632 defined $self->syswrite(join($,, @_) . $\);
634 defined $self->syswrite(join("", @_) . $\);
638 defined $self->syswrite(join($,, @_));
640 defined $self->syswrite(join("", @_));
649 defined $self->syswrite(sprintf($fmt, @_));
659 my $status = *$self->{Compress}->flush(*$self->{Buffer}, $opt) ;
660 return $self->saveErrorString(0, *$self->{Compress}{Error}, *$self->{Compress}{ErrorNo})
661 if $status == STATUS_ERROR;
663 if ( defined *$self->{FH} ) {
664 *$self->{FH}->clearerr();
665 defined *$self->{FH}->write(${ *$self->{Buffer} }, length ${ *$self->{Buffer} })
666 or return $self->saveErrorString(0, $!, $!);
667 ${ *$self->{Buffer} } = '' ;
677 $self->_writeTrailer()
680 my $got = $self->checkParams('newStream', *$self->{Got}, @_)
683 $self->ckParams($got)
684 or $self->croakError("newStream: $self->{Error}");
686 *$self->{Header} = $self->mkHeader($got) ;
687 ${ *$self->{Buffer} } .= *$self->{Header} ;
689 if (defined *$self->{FH})
691 defined *$self->{FH}->write(${ *$self->{Buffer} },
692 length ${ *$self->{Buffer} })
693 or return $self->saveErrorString(0, $!, $!);
694 ${ *$self->{Buffer} } = '' ;
697 my $status = *$self->{Compress}->reset() ;
698 return $self->saveErrorString(0, *$self->{Compress}{Error},
699 *$self->{Compress}{ErrorNo})
700 if $status == STATUS_ERROR;
702 *$self->{BytesWritten} = 0 ;
703 *$self->{UnCompSize_32bit} = 0 ;
712 my $status = *$self->{Compress}->close(*$self->{Buffer}) ;
713 return $self->saveErrorString(0, *$self->{Compress}{Error}, *$self->{Compress}{ErrorNo})
714 if $status == STATUS_ERROR;
716 my $trailer = $self->mkTrailer();
720 ${ *$self->{Buffer} } .= $trailer;
722 return 1 if ! defined *$self->{FH} ;
724 defined *$self->{FH}->write(${ *$self->{Buffer} }, length ${ *$self->{Buffer} })
725 or return $self->saveErrorString(0, $!, $!);
727 ${ *$self->{Buffer} } = '' ;
732 sub _writeFinalTrailer
736 ${ *$self->{Buffer} } .= $self->mkFinalTrailer();
738 return 1 if ! defined *$self->{FH} ;
740 defined *$self->{FH}->write(${ *$self->{Buffer} }, length ${ *$self->{Buffer} })
741 or return $self->saveErrorString(0, $!, $!);
743 ${ *$self->{Buffer} } = '' ;
752 return 1 if *$self->{Closed} || ! *$self->{Compress} ;
753 *$self->{Closed} = 1 ;
758 $self->_writeTrailer()
761 $self->_writeFinalTrailer()
764 if (defined *$self->{FH}) {
765 #if (! *$self->{Handle} || *$self->{AutoClose}) {
766 if ((! *$self->{Handle} || *$self->{AutoClose}) && ! *$self->{StdIO}) {
768 *$self->{FH}->close()
769 or return $self->saveErrorString(0, $!, $!);
771 delete *$self->{FH} ;
772 # This delete can set $! in older Perls, so reset the errno
787 # return *$self->{Compress}->crc32() ;
793 # return *$self->{Compress}->msg() ;
799 # return *$self->{Compress}->dict_adler() ;
805 # return *$self->{Compress}->get_Level() ;
811 # return *$self->{Compress}->get_Strategy() ;
819 #return *$self->{Compress}->total_in();
820 return *$self->{BytesWritten} ;
827 return *$self->{Closed} ;
834 my $position = shift;
837 my $here = $self->tell() ;
840 #use IO::Handle qw(SEEK_SET SEEK_CUR SEEK_END);
843 if ($whence == IO::Handle::SEEK_SET) {
844 $target = $position ;
846 elsif ($whence == IO::Handle::SEEK_CUR || $whence == IO::Handle::SEEK_END) {
847 $target = $here + $position ;
850 $self->croakError(*$self->{ClassName} . "::seek: unknown value, $whence, for whence parameter");
853 # short circuit if seeking to current offset
854 return 1 if $target == $here ;
856 # Outlaw any attempt to seek backwards
857 $self->croakError(*$self->{ClassName} . "::seek: cannot seek backwards")
860 # Walk the file to the new offset
861 my $offset = $target - $here ;
864 defined $self->syswrite("\x00" x $offset)
874 # return defined *$self->{FH}
875 # ? binmode *$self->{FH}
882 return defined *$self->{FH}
883 ? *$self->{FH}->fileno()
890 return sub { croak "$name Not Available: File opened only for output" ; } ;
893 *read = _notAvailable('read');
894 *READ = _notAvailable('read');
895 *readline = _notAvailable('readline');
896 *READLINE = _notAvailable('readline');
897 *getc = _notAvailable('getc');
898 *GETC = _notAvailable('getc');
909 *BINMODE = \&binmode;
911 #*sysread = \&_notAvailable;
912 #*syswrite = \&_write;