1 package IO::Compress::RawDeflate ;
10 use IO::Compress::Base 2.011 ;
11 use IO::Compress::Base::Common 2.011 qw(:Status createSelfTiedObject);
12 use IO::Compress::Adapter::Deflate 2.011 ;
17 our ($VERSION, @ISA, @EXPORT_OK, %DEFLATE_CONSTANTS, %EXPORT_TAGS, $RawDeflateError);
20 $RawDeflateError = '';
22 @ISA = qw(Exporter IO::Compress::Base);
23 @EXPORT_OK = qw( $RawDeflateError rawdeflate ) ;
25 %EXPORT_TAGS = ( flush => [qw{
51 foreach (keys %EXPORT_TAGS )
53 push @{$EXPORT_TAGS{constants}},
57 $EXPORT_TAGS{all} = $EXPORT_TAGS{constants} ;
61 %DEFLATE_CONSTANTS = %EXPORT_TAGS;
63 push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ;
65 Exporter::export_ok_tags('all');
73 my $obj = createSelfTiedObject($class, \$RawDeflateError);
75 return $obj->_create(undef, @_);
80 my $obj = createSelfTiedObject(undef, \$RawDeflateError);
81 return $obj->_def(@_);
97 my ($obj, $errstr, $errno) = IO::Compress::Adapter::Deflate::mkCompObject(
99 $got->value('Adler32'),
100 $got->value('Level'),
101 $got->value('Strategy')
104 return $self->saveErrorString(undef, $errstr, $errno)
138 return $self->getZlibParams();
145 use IO::Compress::Base::Common 2.011 qw(:Parse);
146 use Compress::Raw::Zlib 2.011 qw(Z_DEFLATED Z_DEFAULT_COMPRESSION Z_DEFAULT_STRATEGY);
152 #'Method' => [0, 1, Parse_unsigned, Z_DEFLATED],
153 'Level' => [0, 1, Parse_signed, Z_DEFAULT_COMPRESSION],
154 'Strategy' => [0, 1, Parse_signed, Z_DEFAULT_STRATEGY],
156 'CRC32' => [0, 1, Parse_boolean, 0],
157 'ADLER32' => [0, 1, Parse_boolean, 0],
158 'Merge' => [1, 1, Parse_boolean, 0],
166 return ('IO::Uncompress::RawInflate',
167 \$IO::Uncompress::RawInflate::RawInflateError);
178 use IO::Seekable qw(SEEK_SET);
183 my $outValue = shift ;
184 my $outType = shift ;
186 my ($invClass, $error_ref) = $self->getInverseClass();
187 eval "require $invClass"
190 my $inf = $invClass->new( $outValue,
195 or return $self->saveErrorString(undef, "Cannot create InflateScan object: $$error_ref" ) ;
199 or return $self->saveErrorString(undef, "Error Scanning: $$error_ref", $inf->errorNo) ;
200 $inf->zap($end_offset)
201 or return $self->saveErrorString(undef, "Error Zapping: $$error_ref", $inf->errorNo) ;
203 my $def = *$self->{Compress} = $inf->createDeflate();
205 *$self->{Header} = *$inf->{Info}{Header};
206 *$self->{UnCompSize} = *$inf->{UnCompSize}->clone();
207 *$self->{CompSize} = *$inf->{CompSize}->clone();
209 #*$self->{CompSize} = new U64(0, *$self->{UnCompSize_32bit});
212 if ( $outType eq 'buffer')
213 { substr( ${ *$self->{Buffer} }, $end_offset) = '' }
214 elsif ($outType eq 'handle' || $outType eq 'filename') {
215 *$self->{FH} = *$inf->{FH} ;
217 *$self->{FH}->flush() ;
218 *$self->{Handle} = 1 if $outType eq 'handle';
220 #seek(*$self->{FH}, $end_offset, SEEK_SET)
221 *$self->{FH}->seek($end_offset, SEEK_SET)
222 or return $self->saveErrorString(undef, $!, $!) ;
228 #### zlib specific methods
235 my $strategy = shift ;
237 my $status = *$self->{Compress}->deflateParams(Level => $level, Strategy => $strategy) ;
238 return $self->saveErrorString(0, *$self->{Compress}{Error}, *$self->{Compress}{ErrorNo})
239 if $status == STATUS_ERROR;
253 IO::Compress::RawDeflate - Write RFC 1951 files/buffers
259 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
261 my $status = rawdeflate $input => $output [,OPTS]
262 or die "rawdeflate failed: $RawDeflateError\n";
264 my $z = new IO::Compress::RawDeflate $output [,OPTS]
265 or die "rawdeflate failed: $RawDeflateError\n";
268 $z->printf($format, $string);
270 $z->syswrite($string [, $length, $offset]);
274 $z->seek($position, $whence);
279 $z->input_line_number();
280 $z->newStream( [OPTS] );
291 printf $z $format, $string;
294 seek $z, $position, $whence
302 This module provides a Perl interface that allows writing compressed
303 data to files or buffer as defined in RFC 1951.
305 Note that RFC 1951 data is not a good choice of compression format
306 to use in isolation, especially if you want to auto-detect it.
308 For reading RFC 1951 files/buffers, see the companion module
309 L<IO::Uncompress::RawInflate|IO::Uncompress::RawInflate>.
311 =head1 Functional Interface
313 A top-level function, C<rawdeflate>, is provided to carry out
314 "one-shot" compression between buffers and/or files. For finer
315 control over the compression process, see the L</"OO Interface">
318 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
320 rawdeflate $input => $output [,OPTS]
321 or die "rawdeflate failed: $RawDeflateError\n";
323 The functional interface needs Perl5.005 or better.
325 =head2 rawdeflate $input => $output [, OPTS]
327 C<rawdeflate> expects at least two parameters, C<$input> and C<$output>.
329 =head3 The C<$input> parameter
331 The parameter, C<$input>, is used to define the source of
332 the uncompressed data.
334 It can take one of the following forms:
340 If the C<$input> parameter is a simple scalar, it is assumed to be a
341 filename. This file will be opened for reading and the input data
342 will be read from it.
346 If the C<$input> parameter is a filehandle, the input data will be
348 The string '-' can be used as an alias for standard input.
350 =item A scalar reference
352 If C<$input> is a scalar reference, the input data will be read
355 =item An array reference
357 If C<$input> is an array reference, each element in the array must be a
360 The input data will be read from each file in turn.
362 The complete array will be walked to ensure that it only
363 contains valid filenames before any data is compressed.
365 =item An Input FileGlob string
367 If C<$input> is a string that is delimited by the characters "<" and ">"
368 C<rawdeflate> will assume that it is an I<input fileglob string>. The
369 input is the list of files that match the fileglob.
371 If the fileglob does not match any files ...
373 See L<File::GlobMapper|File::GlobMapper> for more details.
377 If the C<$input> parameter is any other type, C<undef> will be returned.
379 =head3 The C<$output> parameter
381 The parameter C<$output> is used to control the destination of the
382 compressed data. This parameter can take one of these forms.
388 If the C<$output> parameter is a simple scalar, it is assumed to be a
389 filename. This file will be opened for writing and the compressed
390 data will be written to it.
394 If the C<$output> parameter is a filehandle, the compressed data
395 will be written to it.
396 The string '-' can be used as an alias for standard output.
398 =item A scalar reference
400 If C<$output> is a scalar reference, the compressed data will be
401 stored in C<$$output>.
403 =item An Array Reference
405 If C<$output> is an array reference, the compressed data will be
406 pushed onto the array.
408 =item An Output FileGlob
410 If C<$output> is a string that is delimited by the characters "<" and ">"
411 C<rawdeflate> will assume that it is an I<output fileglob string>. The
412 output is the list of files that match the fileglob.
414 When C<$output> is an fileglob string, C<$input> must also be a fileglob
415 string. Anything else is an error.
419 If the C<$output> parameter is any other type, C<undef> will be returned.
423 When C<$input> maps to multiple files/buffers and C<$output> is a single
424 file/buffer the input files/buffers will be stored
425 in C<$output> as a concatenated series of compressed data streams.
427 =head2 Optional Parameters
429 Unless specified below, the optional parameters for C<rawdeflate>,
430 C<OPTS>, are the same as those used with the OO interface defined in the
431 L</"Constructor Options"> section below.
435 =item C<< AutoClose => 0|1 >>
437 This option applies to any input or output data streams to
438 C<rawdeflate> that are filehandles.
440 If C<AutoClose> is specified, and the value is true, it will result in all
441 input and/or output filehandles being closed once C<rawdeflate> has
444 This parameter defaults to 0.
446 =item C<< BinModeIn => 0|1 >>
448 When reading from a file or filehandle, set C<binmode> before reading.
452 =item C<< Append => 0|1 >>
460 To read the contents of the file C<file1.txt> and write the compressed
461 data to the file C<file1.txt.1951>.
465 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
467 my $input = "file1.txt";
468 rawdeflate $input => "$input.1951"
469 or die "rawdeflate failed: $RawDeflateError\n";
471 To read from an existing Perl filehandle, C<$input>, and write the
472 compressed data to a buffer, C<$buffer>.
476 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
479 my $input = new IO::File "<file1.txt"
480 or die "Cannot open 'file1.txt': $!\n" ;
482 rawdeflate $input => \$buffer
483 or die "rawdeflate failed: $RawDeflateError\n";
485 To compress all files in the directory "/my/home" that match "*.txt"
486 and store the compressed data in the same directory
490 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
492 rawdeflate '</my/home/*.txt>' => '<*.1951>'
493 or die "rawdeflate failed: $RawDeflateError\n";
495 and if you want to compress each file one at a time, this will do the trick
499 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
501 for my $input ( glob "/my/home/*.txt" )
503 my $output = "$input.1951" ;
504 rawdeflate $input => $output
505 or die "Error compressing '$input': $RawDeflateError\n";
512 The format of the constructor for C<IO::Compress::RawDeflate> is shown below
514 my $z = new IO::Compress::RawDeflate $output [,OPTS]
515 or die "IO::Compress::RawDeflate failed: $RawDeflateError\n";
517 It returns an C<IO::Compress::RawDeflate> object on success and undef on failure.
518 The variable C<$RawDeflateError> will contain an error message on failure.
520 If you are running Perl 5.005 or better the object, C<$z>, returned from
521 IO::Compress::RawDeflate can be used exactly like an L<IO::File|IO::File> filehandle.
522 This means that all normal output file operations can be carried out
524 For example, to write to a compressed file/buffer you can use either of
527 $z->print("hello world\n");
528 print $z "hello world\n";
530 The mandatory parameter C<$output> is used to control the destination
531 of the compressed data. This parameter can take one of these forms.
537 If the C<$output> parameter is a simple scalar, it is assumed to be a
538 filename. This file will be opened for writing and the compressed data
539 will be written to it.
543 If the C<$output> parameter is a filehandle, the compressed data will be
545 The string '-' can be used as an alias for standard output.
547 =item A scalar reference
549 If C<$output> is a scalar reference, the compressed data will be stored
554 If the C<$output> parameter is any other type, C<IO::Compress::RawDeflate>::new will
557 =head2 Constructor Options
559 C<OPTS> is any combination of the following options:
563 =item C<< AutoClose => 0|1 >>
565 This option is only valid when the C<$output> parameter is a filehandle. If
566 specified, and the value is true, it will result in the C<$output> being
567 closed once either the C<close> method is called or the C<IO::Compress::RawDeflate>
570 This parameter defaults to 0.
572 =item C<< Append => 0|1 >>
574 Opens C<$output> in append mode.
576 The behaviour of this option is dependent on the type of C<$output>.
582 If C<$output> is a buffer and C<Append> is enabled, all compressed data
583 will be append to the end if C<$output>. Otherwise C<$output> will be
584 cleared before any data is written to it.
588 If C<$output> is a filename and C<Append> is enabled, the file will be
589 opened in append mode. Otherwise the contents of the file, if any, will be
590 truncated before any compressed data is written to it.
594 If C<$output> is a filehandle, the file pointer will be positioned to the
595 end of the file via a call to C<seek> before any compressed data is written
596 to it. Otherwise the file pointer will not be moved.
600 This parameter defaults to 0.
602 =item C<< Merge => 0|1 >>
604 This option is used to compress input data and append it to an existing
605 compressed data stream in C<$output>. The end result is a single compressed
606 data stream stored in C<$output>.
608 It is a fatal error to attempt to use this option when C<$output> is not an
609 RFC 1951 data stream.
611 There are a number of other limitations with the C<Merge> option:
617 This module needs to have been built with zlib 1.2.1 or better to work. A
618 fatal error will be thrown if C<Merge> is used with an older version of
623 If C<$output> is a file or a filehandle, it must be seekable.
627 This parameter defaults to 0.
631 Defines the compression level used by zlib. The value should either be
632 a number between 0 and 9 (0 means no compression and 9 is maximum
633 compression), or one of the symbolic constants defined below.
638 Z_DEFAULT_COMPRESSION
640 The default is Z_DEFAULT_COMPRESSION.
642 Note, these constants are not imported by C<IO::Compress::RawDeflate> by default.
644 use IO::Compress::RawDeflate qw(:strategy);
645 use IO::Compress::RawDeflate qw(:constants);
646 use IO::Compress::RawDeflate qw(:all);
650 Defines the strategy used to tune the compression. Use one of the symbolic
651 constants defined below.
659 The default is Z_DEFAULT_STRATEGY.
661 =item C<< Strict => 0|1 >>
663 This is a placeholder option.
680 Compresses and outputs the contents of the C<$data> parameter. This
681 has the same behaviour as the C<print> built-in.
683 Returns true if successful.
689 $z->printf($format, $data)
690 printf $z $format, $data
692 Compresses and outputs the contents of the C<$data> parameter.
694 Returns true if successful.
701 $z->syswrite $data, $length
702 $z->syswrite $data, $length, $offset
704 Compresses and outputs the contents of the C<$data> parameter.
706 Returns the number of uncompressed bytes written, or C<undef> if
714 $z->write $data, $length
715 $z->write $data, $length, $offset
717 Compresses and outputs the contents of the C<$data> parameter.
719 Returns the number of uncompressed bytes written, or C<undef> if
727 $z->flush($flush_type);
729 Flushes any pending compressed data to the output file/buffer.
731 This method takes an optional parameter, C<$flush_type>, that controls
732 how the flushing will be carried out. By default the C<$flush_type>
733 used is C<Z_FINISH>. Other valid values for C<$flush_type> are
734 C<Z_NO_FLUSH>, C<Z_SYNC_FLUSH>, C<Z_FULL_FLUSH> and C<Z_BLOCK>. It is
735 strongly recommended that you only set the C<flush_type> parameter if
736 you fully understand the implications of what it does - overuse of C<flush>
737 can seriously degrade the level of compression achieved. See the C<zlib>
738 documentation for details.
740 Returns true on success.
749 Returns the uncompressed file offset.
758 Returns true if the C<close> method has been called.
762 $z->seek($position, $whence);
763 seek($z, $position, $whence);
765 Provides a sub-set of the C<seek> functionality, with the restriction
766 that it is only legal to seek forward in the output file/buffer.
767 It is a fatal error to attempt to seek backward.
769 Empty parts of the file/buffer will have NULL (0x00) bytes written to them.
771 The C<$whence> parameter takes one the usual values, namely SEEK_SET,
772 SEEK_CUR or SEEK_END.
774 Returns 1 on success, 0 on failure.
783 This is a noop provided for completeness.
789 Returns true if the object currently refers to a opened file/buffer.
793 my $prev = $z->autoflush()
794 my $prev = $z->autoflush(EXPR)
796 If the C<$z> object is associated with a file or a filehandle, this method
797 returns the current autoflush setting for the underlying filehandle. If
798 C<EXPR> is present, and is non-zero, it will enable flushing after every
799 write/print operation.
801 If C<$z> is associated with a buffer, this method has no effect and always
804 B<Note> that the special variable C<$|> B<cannot> be used to set or
805 retrieve the autoflush setting.
807 =head2 input_line_number
809 $z->input_line_number()
810 $z->input_line_number(EXPR)
812 This method always returns C<undef> when compressing.
819 If the C<$z> object is associated with a file or a filehandle, C<fileno>
820 will return the underlying file descriptor. Once the C<close> method is
821 called C<fileno> will return C<undef>.
823 If the C<$z> object is is associated with a buffer, this method will return
831 Flushes any pending compressed data and then closes the output file/buffer.
833 For most versions of Perl this method will be automatically invoked if
834 the IO::Compress::RawDeflate object is destroyed (either explicitly or by the
835 variable with the reference to the object going out of scope). The
836 exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In
837 these cases, the C<close> method will be called automatically, but
838 not until global destruction of all live objects when the program is
841 Therefore, if you want your scripts to be able to run on all versions
842 of Perl, you should call C<close> explicitly and not rely on automatic
845 Returns true on success, otherwise 0.
847 If the C<AutoClose> option has been enabled when the IO::Compress::RawDeflate
848 object was created, and the object is associated with a file, the
849 underlying file will also be closed.
851 =head2 newStream([OPTS])
855 $z->newStream( [OPTS] )
857 Closes the current compressed data stream and starts a new one.
859 OPTS consists of any of the the options that are available when creating
862 See the L</"Constructor Options"> section for more details.
874 A number of symbolic constants are required by some methods in
875 C<IO::Compress::RawDeflate>. None are imported by default.
881 Imports C<rawdeflate>, C<$RawDeflateError> and all symbolic
882 constants that can be used by C<IO::Compress::RawDeflate>. Same as doing this
884 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError :constants) ;
888 Import all symbolic constants. Same as doing this
890 use IO::Compress::RawDeflate qw(:flush :level :strategy) ;
894 These symbolic constants are used by the C<flush> method.
905 These symbolic constants are used by the C<Level> option in the constructor.
910 Z_DEFAULT_COMPRESSION
914 These symbolic constants are used by the C<Strategy> option in the constructor.
929 =head2 Apache::GZip Revisited
931 See L<IO::Compress::Zlib::FAQ|IO::Compress::Zlib::FAQ/"Apache::GZip Revisited">
935 =head2 Working with Net::FTP
937 See L<IO::Compress::Zlib::FAQ|IO::Compress::Zlib::FAQ/"Compressed files and Net::FTP">
941 L<Compress::Zlib>, L<IO::Compress::Gzip>, L<IO::Uncompress::Gunzip>, L<IO::Compress::Deflate>, L<IO::Uncompress::Inflate>, 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::AnyInflate>, L<IO::Uncompress::AnyUncompress>
943 L<Compress::Zlib::FAQ|Compress::Zlib::FAQ>
945 L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>,
946 L<Archive::Tar|Archive::Tar>,
949 For RFC 1950, 1951 and 1952 see
950 F<http://www.faqs.org/rfcs/rfc1950.html>,
951 F<http://www.faqs.org/rfcs/rfc1951.html> and
952 F<http://www.faqs.org/rfcs/rfc1952.html>
954 The I<zlib> compression library was written by Jean-loup Gailly
955 F<gzip@prep.ai.mit.edu> and Mark Adler F<madler@alumni.caltech.edu>.
957 The primary site for the I<zlib> compression library is
958 F<http://www.zlib.org>.
960 The primary site for gzip is F<http://www.gzip.org>.
964 This module was written by Paul Marquess, F<pmqs@cpan.org>.
966 =head1 MODIFICATION HISTORY
968 See the Changes file.
970 =head1 COPYRIGHT AND LICENSE
972 Copyright (c) 2005-2008 Paul Marquess. All rights reserved.
974 This program is free software; you can redistribute it and/or
975 modify it under the same terms as Perl itself.