1 package IO::Uncompress::AnyInflate ;
3 # for RFC1950, RFC1951 or RFC1952
9 use IO::Compress::Base::Common 2.021 qw(createSelfTiedObject);
11 use IO::Uncompress::Adapter::Inflate 2.021 ();
14 use IO::Uncompress::Base 2.021 ;
15 use IO::Uncompress::Gunzip 2.021 ;
16 use IO::Uncompress::Inflate 2.021 ;
17 use IO::Uncompress::RawInflate 2.021 ;
18 use IO::Uncompress::Unzip 2.021 ;
22 our ($VERSION, @ISA, @EXPORT_OK, %EXPORT_TAGS, $AnyInflateError);
25 $AnyInflateError = '';
27 @ISA = qw( Exporter IO::Uncompress::Base );
28 @EXPORT_OK = qw( $AnyInflateError anyinflate ) ;
29 %EXPORT_TAGS = %IO::Uncompress::Base::DEFLATE_CONSTANTS ;
30 push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ;
31 Exporter::export_ok_tags('all');
33 # TODO - allow the user to pick a set of the three formats to allow
34 # or just assume want to auto-detect any of the three formats.
39 my $obj = createSelfTiedObject($class, \$AnyInflateError);
40 $obj->_create(undef, 0, @_);
45 my $obj = createSelfTiedObject(undef, \$AnyInflateError);
46 return $obj->_inf(@_) ;
51 use IO::Compress::Base::Common 2.021 qw(:Parse);
52 return ( 'RawInflate' => [1, 1, Parse_boolean, 0] ) ;
60 # any always needs both crc32 and adler32
61 $got->value('CRC32' => 1);
62 $got->value('ADLER32' => 1);
72 my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::Inflate::mkUncompObject();
74 return $self->saveErrorString(undef, $errstr, $errno)
77 *$self->{Uncomp} = $obj;
79 my @possible = qw( Inflate Gunzip Unzip );
80 unshift @possible, 'RawInflate'
81 if 1 || $got->value('RawInflate');
83 my $magic = $self->ckMagic( @possible );
86 *$self->{Info} = $self->readHeader($magic)
102 my $keep = ref $self ;
103 for my $class ( map { "IO::Uncompress::$_" } @names)
105 bless $self => $class;
106 my $magic = $self->ckMagic();
110 #bless $self => $class;
114 $self->pushBack(*$self->{HeaderPending}) ;
115 *$self->{HeaderPending} = '' ;
118 bless $self => $keep;
129 IO::Uncompress::AnyInflate - Uncompress zlib-based (zip, gzip) file/buffer
133 use IO::Uncompress::AnyInflate qw(anyinflate $AnyInflateError) ;
135 my $status = anyinflate $input => $output [,OPTS]
136 or die "anyinflate failed: $AnyInflateError\n";
138 my $z = new IO::Uncompress::AnyInflate $input [OPTS]
139 or die "anyinflate failed: $AnyInflateError\n";
141 $status = $z->read($buffer)
142 $status = $z->read($buffer, $length)
143 $status = $z->read($buffer, $length, $offset)
144 $line = $z->getline()
149 $status = $z->inflateSync()
151 $data = $z->trailingData()
152 $status = $z->nextStream()
153 $data = $z->getHeaderInfo()
155 $z->seek($position, $whence)
167 read($z, $buffer, $length);
168 read($z, $buffer, $length, $offset);
170 seek($z, $position, $whence)
178 This module provides a Perl interface that allows the reading of
179 files/buffers that have been compressed in a number of formats that use the
180 zlib compression library.
182 The formats supported are
188 =item RFC 1951 (optionally)
190 =item gzip (RFC 1952)
196 The module will auto-detect which, if any, of the supported
197 compression formats is being used.
199 =head1 Functional Interface
201 A top-level function, C<anyinflate>, is provided to carry out
202 "one-shot" uncompression between buffers and/or files. For finer
203 control over the uncompression process, see the L</"OO Interface">
206 use IO::Uncompress::AnyInflate qw(anyinflate $AnyInflateError) ;
208 anyinflate $input => $output [,OPTS]
209 or die "anyinflate failed: $AnyInflateError\n";
211 The functional interface needs Perl5.005 or better.
213 =head2 anyinflate $input => $output [, OPTS]
215 C<anyinflate> expects at least two parameters, C<$input> and C<$output>.
217 =head3 The C<$input> parameter
219 The parameter, C<$input>, is used to define the source of
222 It can take one of the following forms:
228 If the C<$input> parameter is a simple scalar, it is assumed to be a
229 filename. This file will be opened for reading and the input data
230 will be read from it.
234 If the C<$input> parameter is a filehandle, the input data will be
236 The string '-' can be used as an alias for standard input.
238 =item A scalar reference
240 If C<$input> is a scalar reference, the input data will be read
243 =item An array reference
245 If C<$input> is an array reference, each element in the array must be a
248 The input data will be read from each file in turn.
250 The complete array will be walked to ensure that it only
251 contains valid filenames before any data is uncompressed.
253 =item An Input FileGlob string
255 If C<$input> is a string that is delimited by the characters "<" and ">"
256 C<anyinflate> will assume that it is an I<input fileglob string>. The
257 input is the list of files that match the fileglob.
259 If the fileglob does not match any files ...
261 See L<File::GlobMapper|File::GlobMapper> for more details.
265 If the C<$input> parameter is any other type, C<undef> will be returned.
267 =head3 The C<$output> parameter
269 The parameter C<$output> is used to control the destination of the
270 uncompressed data. This parameter can take one of these forms.
276 If the C<$output> parameter is a simple scalar, it is assumed to be a
277 filename. This file will be opened for writing and the uncompressed
278 data will be written to it.
282 If the C<$output> parameter is a filehandle, the uncompressed data
283 will be written to it.
284 The string '-' can be used as an alias for standard output.
286 =item A scalar reference
288 If C<$output> is a scalar reference, the uncompressed data will be
289 stored in C<$$output>.
291 =item An Array Reference
293 If C<$output> is an array reference, the uncompressed data will be
294 pushed onto the array.
296 =item An Output FileGlob
298 If C<$output> is a string that is delimited by the characters "<" and ">"
299 C<anyinflate> will assume that it is an I<output fileglob string>. The
300 output is the list of files that match the fileglob.
302 When C<$output> is an fileglob string, C<$input> must also be a fileglob
303 string. Anything else is an error.
307 If the C<$output> parameter is any other type, C<undef> will be returned.
311 When C<$input> maps to multiple compressed files/buffers and C<$output> is
312 a single file/buffer, after uncompression C<$output> will contain a
313 concatenation of all the uncompressed data from each of the input
316 =head2 Optional Parameters
318 Unless specified below, the optional parameters for C<anyinflate>,
319 C<OPTS>, are the same as those used with the OO interface defined in the
320 L</"Constructor Options"> section below.
324 =item C<< AutoClose => 0|1 >>
326 This option applies to any input or output data streams to
327 C<anyinflate> that are filehandles.
329 If C<AutoClose> is specified, and the value is true, it will result in all
330 input and/or output filehandles being closed once C<anyinflate> has
333 This parameter defaults to 0.
335 =item C<< BinModeOut => 0|1 >>
337 When writing to a file or filehandle, set C<binmode> before writing to the
342 =item C<< Append => 0|1 >>
346 =item C<< MultiStream => 0|1 >>
348 If the input file/buffer contains multiple compressed data streams, this
349 option will uncompress the whole lot as a single data stream.
353 =item C<< TrailingData => $scalar >>
355 Returns the data, if any, that is present immediately after the compressed
356 data stream once uncompression is complete.
358 This option can be used when there is useful information immediately
359 following the compressed data stream, and you don't know the length of the
360 compressed data stream.
362 If the input is a buffer, C<trailingData> will return everything from the
363 end of the compressed data stream to the end of the buffer.
365 If the input is a filehandle, C<trailingData> will return the data that is
366 left in the filehandle input buffer once the end of the compressed data
367 stream has been reached. You can then use the filehandle to read the rest
370 Don't bother using C<trailingData> if the input is a filename.
372 If you know the length of the compressed data stream before you start
373 uncompressing, you can avoid having to use C<trailingData> by setting the
374 C<InputLength> option.
380 To read the contents of the file C<file1.txt.Compressed> and write the
381 uncompressed data to the file C<file1.txt>.
385 use IO::Uncompress::AnyInflate qw(anyinflate $AnyInflateError) ;
387 my $input = "file1.txt.Compressed";
388 my $output = "file1.txt";
389 anyinflate $input => $output
390 or die "anyinflate failed: $AnyInflateError\n";
392 To read from an existing Perl filehandle, C<$input>, and write the
393 uncompressed data to a buffer, C<$buffer>.
397 use IO::Uncompress::AnyInflate qw(anyinflate $AnyInflateError) ;
400 my $input = new IO::File "<file1.txt.Compressed"
401 or die "Cannot open 'file1.txt.Compressed': $!\n" ;
403 anyinflate $input => \$buffer
404 or die "anyinflate failed: $AnyInflateError\n";
406 To uncompress all files in the directory "/my/home" that match "*.txt.Compressed" and store the compressed data in the same directory
410 use IO::Uncompress::AnyInflate qw(anyinflate $AnyInflateError) ;
412 anyinflate '</my/home/*.txt.Compressed>' => '</my/home/#1.txt>'
413 or die "anyinflate failed: $AnyInflateError\n";
415 and if you want to compress each file one at a time, this will do the trick
419 use IO::Uncompress::AnyInflate qw(anyinflate $AnyInflateError) ;
421 for my $input ( glob "/my/home/*.txt.Compressed" )
424 $output =~ s/.Compressed// ;
425 anyinflate $input => $output
426 or die "Error compressing '$input': $AnyInflateError\n";
433 The format of the constructor for IO::Uncompress::AnyInflate is shown below
435 my $z = new IO::Uncompress::AnyInflate $input [OPTS]
436 or die "IO::Uncompress::AnyInflate failed: $AnyInflateError\n";
438 Returns an C<IO::Uncompress::AnyInflate> object on success and undef on failure.
439 The variable C<$AnyInflateError> will contain an error message on failure.
441 If you are running Perl 5.005 or better the object, C<$z>, returned from
442 IO::Uncompress::AnyInflate can be used exactly like an L<IO::File|IO::File> filehandle.
443 This means that all normal input file operations can be carried out with
444 C<$z>. For example, to read a line from a compressed file/buffer you can
445 use either of these forms
447 $line = $z->getline();
450 The mandatory parameter C<$input> is used to determine the source of the
451 compressed data. This parameter can take one of three forms.
457 If the C<$input> parameter is a scalar, it is assumed to be a filename. This
458 file will be opened for reading and the compressed data will be read from it.
462 If the C<$input> parameter is a filehandle, the compressed data will be
464 The string '-' can be used as an alias for standard input.
466 =item A scalar reference
468 If C<$input> is a scalar reference, the compressed data will be read from
473 =head2 Constructor Options
475 The option names defined below are case insensitive and can be optionally
476 prefixed by a '-'. So all of the following are valid
483 OPTS is a combination of the following options:
487 =item C<< AutoClose => 0|1 >>
489 This option is only valid when the C<$input> parameter is a filehandle. If
490 specified, and the value is true, it will result in the file being closed once
491 either the C<close> method is called or the IO::Uncompress::AnyInflate object is
494 This parameter defaults to 0.
496 =item C<< MultiStream => 0|1 >>
498 Allows multiple concatenated compressed streams to be treated as a single
499 compressed stream. Decompression will stop once either the end of the
500 file/buffer is reached, an error is encountered (premature eof, corrupt
501 compressed data) or the end of a stream is not immediately followed by the
502 start of another stream.
504 This parameter defaults to 0.
506 =item C<< Prime => $string >>
508 This option will uncompress the contents of C<$string> before processing the
511 This option can be useful when the compressed data is embedded in another
512 file/data structure and it is not possible to work out where the compressed
513 data begins without having to read the first few bytes. If this is the
514 case, the uncompression can be I<primed> with these bytes using this
517 =item C<< Transparent => 0|1 >>
519 If this option is set and the input file/buffer is not compressed data,
520 the module will allow reading of it anyway.
522 In addition, if the input file/buffer does contain compressed data and
523 there is non-compressed data immediately following it, setting this option
524 will make this module treat the whole file/bufffer as a single data stream.
526 This option defaults to 1.
528 =item C<< BlockSize => $num >>
530 When reading the compressed input data, IO::Uncompress::AnyInflate will read it in
531 blocks of C<$num> bytes.
533 This option defaults to 4096.
535 =item C<< InputLength => $size >>
537 When present this option will limit the number of compressed bytes read
538 from the input file/buffer to C<$size>. This option can be used in the
539 situation where there is useful data directly after the compressed data
540 stream and you know beforehand the exact length of the compressed data
543 This option is mostly used when reading from a filehandle, in which case
544 the file pointer will be left pointing to the first byte directly after the
545 compressed data stream.
547 This option defaults to off.
549 =item C<< Append => 0|1 >>
551 This option controls what the C<read> method does with uncompressed data.
553 If set to 1, all uncompressed data will be appended to the output parameter
554 of the C<read> method.
556 If set to 0, the contents of the output parameter of the C<read> method
557 will be overwritten by the uncompressed data.
561 =item C<< Strict => 0|1 >>
563 This option controls whether the extra checks defined below are used when
564 carrying out the decompression. When Strict is on, the extra tests are
565 carried out, when Strict is off they are not.
567 The default for this option is off.
569 If the input is an RFC 1950 data stream, the following will be checked:
575 The ADLER32 checksum field must be present.
579 The value of the ADLER32 field read must match the adler32 value of the
580 uncompressed data actually contained in the file.
584 If the input is a gzip (RFC 1952) data stream, the following will be checked:
590 If the FHCRC bit is set in the gzip FLG header byte, the CRC16 bytes in the
591 header must match the crc16 value of the gzip header actually read.
595 If the gzip header contains a name field (FNAME) it consists solely of ISO
600 If the gzip header contains a comment field (FCOMMENT) it consists solely
601 of ISO 8859-1 characters plus line-feed.
605 If the gzip FEXTRA header field is present it must conform to the sub-field
606 structure as defined in RFC 1952.
610 The CRC32 and ISIZE trailer fields must be present.
614 The value of the CRC32 field read must match the crc32 value of the
615 uncompressed data actually contained in the gzip file.
619 The value of the ISIZE fields read must match the length of the
620 uncompressed data actually read from the file.
624 =item C<< RawInflate => 0|1 >>
626 When auto-detecting the compressed format, try to test for raw-deflate (RFC
627 1951) content using the C<IO::Uncompress::RawInflate> module.
629 The reason this is not default behaviour is because RFC 1951 content can
630 only be detected by attempting to uncompress it. This process is error
631 prone and can result is false positives.
635 =item C<< ParseExtra => 0|1 >>
636 If the gzip FEXTRA header field is present and this option is set, it will
637 force the module to check that it conforms to the sub-field structure as
640 If the C<Strict> is on it will automatically enable this option.
656 $status = $z->read($buffer)
658 Reads a block of compressed data (the size the the compressed block is
659 determined by the C<Buffer> option in the constructor), uncompresses it and
660 writes any uncompressed data into C<$buffer>. If the C<Append> parameter is
661 set in the constructor, the uncompressed data will be appended to the
662 C<$buffer> parameter. Otherwise C<$buffer> will be overwritten.
664 Returns the number of uncompressed bytes written to C<$buffer>, zero if eof
665 or a negative number on error.
671 $status = $z->read($buffer, $length)
672 $status = $z->read($buffer, $length, $offset)
674 $status = read($z, $buffer, $length)
675 $status = read($z, $buffer, $length, $offset)
677 Attempt to read C<$length> bytes of uncompressed data into C<$buffer>.
679 The main difference between this form of the C<read> method and the
680 previous one, is that this one will attempt to return I<exactly> C<$length>
681 bytes. The only circumstances that this function will not is if end-of-file
682 or an IO error is encountered.
684 Returns the number of uncompressed bytes written to C<$buffer>, zero if eof
685 or a negative number on error.
691 $line = $z->getline()
696 This method fully supports the use of of the variable C<$/> (or
697 C<$INPUT_RECORD_SEPARATOR> or C<$RS> when C<English> is in use) to
698 determine what constitutes an end of line. Paragraph mode, record mode and
699 file slurp mode are all supported.
707 Read a single character.
713 $char = $z->ungetc($string)
719 $status = $z->inflateSync()
727 $hdr = $z->getHeaderInfo();
728 @hdrs = $z->getHeaderInfo();
730 This method returns either a hash reference (in scalar context) or a list
731 or hash references (in array context) that contains information about each
732 of the header fields in the compressed data stream(s).
741 Returns the uncompressed file offset.
750 Returns true if the end of the compressed input stream has been reached.
754 $z->seek($position, $whence);
755 seek($z, $position, $whence);
757 Provides a sub-set of the C<seek> functionality, with the restriction
758 that it is only legal to seek forward in the input file/buffer.
759 It is a fatal error to attempt to seek backward.
761 The C<$whence> parameter takes one the usual values, namely SEEK_SET,
762 SEEK_CUR or SEEK_END.
764 Returns 1 on success, 0 on failure.
773 This is a noop provided for completeness.
779 Returns true if the object currently refers to a opened file/buffer.
783 my $prev = $z->autoflush()
784 my $prev = $z->autoflush(EXPR)
786 If the C<$z> object is associated with a file or a filehandle, this method
787 returns the current autoflush setting for the underlying filehandle. If
788 C<EXPR> is present, and is non-zero, it will enable flushing after every
789 write/print operation.
791 If C<$z> is associated with a buffer, this method has no effect and always
794 B<Note> that the special variable C<$|> B<cannot> be used to set or
795 retrieve the autoflush setting.
797 =head2 input_line_number
799 $z->input_line_number()
800 $z->input_line_number(EXPR)
802 Returns the current uncompressed line number. If C<EXPR> is present it has
803 the effect of setting the line number. Note that setting the line number
804 does not change the current position within the file/buffer being read.
806 The contents of C<$/> are used to to determine what constitutes a line
814 If the C<$z> object is associated with a file or a filehandle, C<fileno>
815 will return the underlying file descriptor. Once the C<close> method is
816 called C<fileno> will return C<undef>.
818 If the C<$z> object is is associated with a buffer, this method will return
826 Closes the output file/buffer.
828 For most versions of Perl this method will be automatically invoked if
829 the IO::Uncompress::AnyInflate object is destroyed (either explicitly or by the
830 variable with the reference to the object going out of scope). The
831 exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In
832 these cases, the C<close> method will be called automatically, but
833 not until global destruction of all live objects when the program is
836 Therefore, if you want your scripts to be able to run on all versions
837 of Perl, you should call C<close> explicitly and not rely on automatic
840 Returns true on success, otherwise 0.
842 If the C<AutoClose> option has been enabled when the IO::Uncompress::AnyInflate
843 object was created, and the object is associated with a file, the
844 underlying file will also be closed.
850 my $status = $z->nextStream();
852 Skips to the next compressed data stream in the input file/buffer. If a new
853 compressed data stream is found, the eof marker will be cleared and C<$.>
856 Returns 1 if a new stream was found, 0 if none was found, and -1 if an
857 error was encountered.
863 my $data = $z->trailingData();
865 Returns the data, if any, that is present immediately after the compressed
866 data stream once uncompression is complete. It only makes sense to call
867 this method once the end of the compressed data stream has been
870 This option can be used when there is useful information immediately
871 following the compressed data stream, and you don't know the length of the
872 compressed data stream.
874 If the input is a buffer, C<trailingData> will return everything from the
875 end of the compressed data stream to the end of the buffer.
877 If the input is a filehandle, C<trailingData> will return the data that is
878 left in the filehandle input buffer once the end of the compressed data
879 stream has been reached. You can then use the filehandle to read the rest
882 Don't bother using C<trailingData> if the input is a filename.
884 If you know the length of the compressed data stream before you start
885 uncompressing, you can avoid having to use C<trailingData> by setting the
886 C<InputLength> option in the constructor.
890 No symbolic constants are required by this IO::Uncompress::AnyInflate at present.
896 Imports C<anyinflate> and C<$AnyInflateError>.
899 use IO::Uncompress::AnyInflate qw(anyinflate $AnyInflateError) ;
905 =head2 Working with Net::FTP
907 See L<IO::Uncompress::AnyInflate::FAQ|IO::Uncompress::AnyInflate::FAQ/"Compressed files and Net::FTP">
911 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::Compress::Lzf>, L<IO::Uncompress::UnLzf>, L<IO::Uncompress::AnyUncompress>
913 L<Compress::Zlib::FAQ|Compress::Zlib::FAQ>
915 L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>,
916 L<Archive::Tar|Archive::Tar>,
919 For RFC 1950, 1951 and 1952 see
920 F<http://www.faqs.org/rfcs/rfc1950.html>,
921 F<http://www.faqs.org/rfcs/rfc1951.html> and
922 F<http://www.faqs.org/rfcs/rfc1952.html>
924 The I<zlib> compression library was written by Jean-loup Gailly
925 F<gzip@prep.ai.mit.edu> and Mark Adler F<madler@alumni.caltech.edu>.
927 The primary site for the I<zlib> compression library is
928 F<http://www.zlib.org>.
930 The primary site for gzip is F<http://www.gzip.org>.
934 This module was written by Paul Marquess, F<pmqs@cpan.org>.
936 =head1 MODIFICATION HISTORY
938 See the Changes file.
940 =head1 COPYRIGHT AND LICENSE
942 Copyright (c) 2005-2009 Paul Marquess. All rights reserved.
944 This program is free software; you can redistribute it and/or
945 modify it under the same terms as Perl itself.