Commit | Line | Data |
25f0751f |
1 | package IO::Uncompress::AnyUncompress ; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | use bytes; |
6 | |
a1787f24 |
7 | use IO::Compress::Base::Common 2.011 qw(createSelfTiedObject); |
25f0751f |
8 | |
a1787f24 |
9 | use IO::Uncompress::Base 2.011 ; |
25f0751f |
10 | |
25f0751f |
11 | |
12 | require Exporter ; |
13 | |
14 | our ($VERSION, @ISA, @EXPORT_OK, %EXPORT_TAGS, $AnyUncompressError); |
15 | |
a1787f24 |
16 | $VERSION = '2.011'; |
25f0751f |
17 | $AnyUncompressError = ''; |
18 | |
19 | @ISA = qw( Exporter IO::Uncompress::Base ); |
20 | @EXPORT_OK = qw( $AnyUncompressError anyuncompress ) ; |
21 | %EXPORT_TAGS = %IO::Uncompress::Base::DEFLATE_CONSTANTS ; |
22 | push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ; |
23 | Exporter::export_ok_tags('all'); |
24 | |
25 | # TODO - allow the user to pick a set of the three formats to allow |
26 | # or just assume want to auto-detect any of the three formats. |
27 | |
258133d1 |
28 | BEGIN |
29 | { |
a1787f24 |
30 | eval ' use IO::Uncompress::Adapter::Inflate 2.011 ;'; |
31 | eval ' use IO::Uncompress::Adapter::Bunzip2 2.011 ;'; |
32 | eval ' use IO::Uncompress::Adapter::LZO 2.011 ;'; |
33 | eval ' use IO::Uncompress::Adapter::Lzf 2.011 ;'; |
34 | |
35 | eval ' use IO::Uncompress::Bunzip2 2.011 ;'; |
36 | eval ' use IO::Uncompress::UnLzop 2.011 ;'; |
37 | eval ' use IO::Uncompress::Gunzip 2.011 ;'; |
38 | eval ' use IO::Uncompress::Inflate 2.011 ;'; |
39 | eval ' use IO::Uncompress::RawInflate 2.011 ;'; |
40 | eval ' use IO::Uncompress::Unzip 2.011 ;'; |
41 | eval ' use IO::Uncompress::UnLzf 2.011 ;'; |
258133d1 |
42 | } |
43 | |
25f0751f |
44 | sub new |
45 | { |
46 | my $class = shift ; |
47 | my $obj = createSelfTiedObject($class, \$AnyUncompressError); |
48 | $obj->_create(undef, 0, @_); |
49 | } |
50 | |
51 | sub anyuncompress |
52 | { |
53 | my $obj = createSelfTiedObject(undef, \$AnyUncompressError); |
54 | return $obj->_inf(@_) ; |
55 | } |
56 | |
57 | sub getExtraParams |
58 | { |
a1787f24 |
59 | use IO::Compress::Base::Common 2.011 qw(:Parse); |
6ecef415 |
60 | return ( 'RawInflate' => [1, 1, Parse_boolean, 0] ) ; |
25f0751f |
61 | } |
62 | |
63 | sub ckParams |
64 | { |
65 | my $self = shift ; |
66 | my $got = shift ; |
67 | |
68 | # any always needs both crc32 and adler32 |
69 | $got->value('CRC32' => 1); |
70 | $got->value('ADLER32' => 1); |
71 | |
72 | return 1; |
73 | } |
74 | |
75 | sub mkUncomp |
76 | { |
77 | my $self = shift ; |
25f0751f |
78 | my $got = shift ; |
79 | |
cb7abd7f |
80 | my $magic ; |
81 | |
25f0751f |
82 | # try zlib first |
cb7abd7f |
83 | if (defined $IO::Uncompress::RawInflate::VERSION ) |
84 | { |
85 | my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::Inflate::mkUncompObject(); |
25f0751f |
86 | |
cb7abd7f |
87 | return $self->saveErrorString(undef, $errstr, $errno) |
88 | if ! defined $obj; |
25f0751f |
89 | |
cb7abd7f |
90 | *$self->{Uncomp} = $obj; |
91 | |
6ecef415 |
92 | my @possible = qw( Inflate Gunzip Unzip ); |
93 | unshift @possible, 'RawInflate' |
94 | if $got->value('RawInflate'); |
25f0751f |
95 | |
6ecef415 |
96 | $magic = $self->ckMagic( @possible ); |
97 | |
98 | if ($magic) { |
cb7abd7f |
99 | *$self->{Info} = $self->readHeader($magic) |
100 | or return undef ; |
25f0751f |
101 | |
cb7abd7f |
102 | return 1; |
6ecef415 |
103 | } |
25f0751f |
104 | } |
105 | |
25f0751f |
106 | if (defined $IO::Uncompress::Bunzip2::VERSION and |
107 | $magic = $self->ckMagic('Bunzip2')) { |
108 | *$self->{Info} = $self->readHeader($magic) |
109 | or return undef ; |
110 | |
111 | my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::Bunzip2::mkUncompObject(); |
112 | |
113 | return $self->saveErrorString(undef, $errstr, $errno) |
114 | if ! defined $obj; |
115 | |
116 | *$self->{Uncomp} = $obj; |
117 | |
118 | return 1; |
119 | } |
6ecef415 |
120 | |
121 | if (defined $IO::Uncompress::UnLzop::VERSION and |
25f0751f |
122 | $magic = $self->ckMagic('UnLzop')) { |
123 | |
124 | *$self->{Info} = $self->readHeader($magic) |
125 | or return undef ; |
126 | |
127 | my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::LZO::mkUncompObject(); |
128 | |
129 | return $self->saveErrorString(undef, $errstr, $errno) |
130 | if ! defined $obj; |
131 | |
132 | *$self->{Uncomp} = $obj; |
133 | |
134 | return 1; |
135 | } |
136 | |
258133d1 |
137 | if (defined $IO::Uncompress::UnLzf::VERSION and |
138 | $magic = $self->ckMagic('UnLzf')) { |
139 | |
140 | *$self->{Info} = $self->readHeader($magic) |
141 | or return undef ; |
142 | |
143 | my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::Lzf::mkUncompObject(); |
144 | |
145 | return $self->saveErrorString(undef, $errstr, $errno) |
146 | if ! defined $obj; |
147 | |
148 | *$self->{Uncomp} = $obj; |
149 | |
150 | return 1; |
151 | } |
152 | |
25f0751f |
153 | return 0 ; |
154 | } |
155 | |
156 | |
157 | |
158 | sub ckMagic |
159 | { |
160 | my $self = shift; |
161 | my @names = @_ ; |
162 | |
163 | my $keep = ref $self ; |
164 | for my $class ( map { "IO::Uncompress::$_" } @names) |
165 | { |
166 | bless $self => $class; |
167 | my $magic = $self->ckMagic(); |
168 | |
169 | if ($magic) |
170 | { |
171 | #bless $self => $class; |
172 | return $magic ; |
173 | } |
174 | |
175 | $self->pushBack(*$self->{HeaderPending}) ; |
176 | *$self->{HeaderPending} = '' ; |
177 | } |
178 | |
179 | bless $self => $keep; |
180 | return undef; |
181 | } |
182 | |
183 | 1 ; |
184 | |
185 | __END__ |
186 | |
187 | |
188 | =head1 NAME |
189 | |
cb7abd7f |
190 | IO::Uncompress::AnyUncompress - Uncompress gzip, zip, bzip2 or lzop file/buffer |
25f0751f |
191 | |
25f0751f |
192 | =head1 SYNOPSIS |
193 | |
194 | use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ; |
195 | |
196 | my $status = anyuncompress $input => $output [,OPTS] |
197 | or die "anyuncompress failed: $AnyUncompressError\n"; |
198 | |
199 | my $z = new IO::Uncompress::AnyUncompress $input [OPTS] |
200 | or die "anyuncompress failed: $AnyUncompressError\n"; |
201 | |
202 | $status = $z->read($buffer) |
203 | $status = $z->read($buffer, $length) |
204 | $status = $z->read($buffer, $length, $offset) |
205 | $line = $z->getline() |
206 | $char = $z->getc() |
207 | $char = $z->ungetc() |
208 | $char = $z->opened() |
209 | |
e7d45986 |
210 | $data = $z->trailingData() |
211 | $status = $z->nextStream() |
25f0751f |
212 | $data = $z->getHeaderInfo() |
213 | $z->tell() |
214 | $z->seek($position, $whence) |
215 | $z->binmode() |
216 | $z->fileno() |
217 | $z->eof() |
218 | $z->close() |
219 | |
220 | $AnyUncompressError ; |
221 | |
222 | # IO::File mode |
223 | |
224 | <$z> |
225 | read($z, $buffer); |
226 | read($z, $buffer, $length); |
227 | read($z, $buffer, $length, $offset); |
228 | tell($z) |
229 | seek($z, $position, $whence) |
230 | binmode($z) |
231 | fileno($z) |
232 | eof($z) |
233 | close($z) |
234 | |
25f0751f |
235 | =head1 DESCRIPTION |
236 | |
25f0751f |
237 | This module provides a Perl interface that allows the reading of |
cb7abd7f |
238 | files/buffers that have been compressed with a variety of compression |
239 | libraries. |
240 | |
241 | The formats supported are: |
242 | |
243 | =over 5 |
244 | |
245 | =item RFC 1950 |
246 | |
258133d1 |
247 | =item RFC 1951 (optionally) |
cb7abd7f |
248 | |
249 | =item gzip (RFC 1952) |
250 | |
251 | =item zip |
252 | |
253 | =item bzip2 |
254 | |
255 | =item lzop |
256 | |
258133d1 |
257 | =item lzf |
258 | |
cb7abd7f |
259 | =back |
260 | |
261 | The module will auto-detect which, if any, of the supported |
262 | compression formats is being used. |
263 | |
25f0751f |
264 | =head1 Functional Interface |
265 | |
266 | A top-level function, C<anyuncompress>, is provided to carry out |
267 | "one-shot" uncompression between buffers and/or files. For finer |
268 | control over the uncompression process, see the L</"OO Interface"> |
269 | section. |
270 | |
271 | use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ; |
272 | |
273 | anyuncompress $input => $output [,OPTS] |
274 | or die "anyuncompress failed: $AnyUncompressError\n"; |
275 | |
25f0751f |
276 | The functional interface needs Perl5.005 or better. |
277 | |
25f0751f |
278 | =head2 anyuncompress $input => $output [, OPTS] |
279 | |
25f0751f |
280 | C<anyuncompress> expects at least two parameters, C<$input> and C<$output>. |
281 | |
282 | =head3 The C<$input> parameter |
283 | |
284 | The parameter, C<$input>, is used to define the source of |
285 | the compressed data. |
286 | |
287 | It can take one of the following forms: |
288 | |
289 | =over 5 |
290 | |
291 | =item A filename |
292 | |
293 | If the C<$input> parameter is a simple scalar, it is assumed to be a |
294 | filename. This file will be opened for reading and the input data |
295 | will be read from it. |
296 | |
297 | =item A filehandle |
298 | |
299 | If the C<$input> parameter is a filehandle, the input data will be |
300 | read from it. |
301 | The string '-' can be used as an alias for standard input. |
302 | |
303 | =item A scalar reference |
304 | |
305 | If C<$input> is a scalar reference, the input data will be read |
306 | from C<$$input>. |
307 | |
308 | =item An array reference |
309 | |
310 | If C<$input> is an array reference, each element in the array must be a |
311 | filename. |
312 | |
313 | The input data will be read from each file in turn. |
314 | |
315 | The complete array will be walked to ensure that it only |
316 | contains valid filenames before any data is uncompressed. |
317 | |
25f0751f |
318 | =item An Input FileGlob string |
319 | |
320 | If C<$input> is a string that is delimited by the characters "<" and ">" |
321 | C<anyuncompress> will assume that it is an I<input fileglob string>. The |
322 | input is the list of files that match the fileglob. |
323 | |
324 | If the fileglob does not match any files ... |
325 | |
326 | See L<File::GlobMapper|File::GlobMapper> for more details. |
327 | |
25f0751f |
328 | =back |
329 | |
330 | If the C<$input> parameter is any other type, C<undef> will be returned. |
331 | |
25f0751f |
332 | =head3 The C<$output> parameter |
333 | |
334 | The parameter C<$output> is used to control the destination of the |
335 | uncompressed data. This parameter can take one of these forms. |
336 | |
337 | =over 5 |
338 | |
339 | =item A filename |
340 | |
341 | If the C<$output> parameter is a simple scalar, it is assumed to be a |
342 | filename. This file will be opened for writing and the uncompressed |
343 | data will be written to it. |
344 | |
345 | =item A filehandle |
346 | |
347 | If the C<$output> parameter is a filehandle, the uncompressed data |
348 | will be written to it. |
349 | The string '-' can be used as an alias for standard output. |
350 | |
25f0751f |
351 | =item A scalar reference |
352 | |
353 | If C<$output> is a scalar reference, the uncompressed data will be |
354 | stored in C<$$output>. |
355 | |
25f0751f |
356 | =item An Array Reference |
357 | |
358 | If C<$output> is an array reference, the uncompressed data will be |
359 | pushed onto the array. |
360 | |
361 | =item An Output FileGlob |
362 | |
363 | If C<$output> is a string that is delimited by the characters "<" and ">" |
364 | C<anyuncompress> will assume that it is an I<output fileglob string>. The |
365 | output is the list of files that match the fileglob. |
366 | |
367 | When C<$output> is an fileglob string, C<$input> must also be a fileglob |
368 | string. Anything else is an error. |
369 | |
370 | =back |
371 | |
372 | If the C<$output> parameter is any other type, C<undef> will be returned. |
373 | |
25f0751f |
374 | =head2 Notes |
375 | |
c70c1701 |
376 | When C<$input> maps to multiple compressed files/buffers and C<$output> is |
377 | a single file/buffer, after uncompression C<$output> will contain a |
378 | concatenation of all the uncompressed data from each of the input |
379 | files/buffers. |
380 | |
25f0751f |
381 | =head2 Optional Parameters |
382 | |
383 | Unless specified below, the optional parameters for C<anyuncompress>, |
384 | C<OPTS>, are the same as those used with the OO interface defined in the |
385 | L</"Constructor Options"> section below. |
386 | |
387 | =over 5 |
388 | |
e7d45986 |
389 | =item C<< AutoClose => 0|1 >> |
25f0751f |
390 | |
391 | This option applies to any input or output data streams to |
392 | C<anyuncompress> that are filehandles. |
393 | |
394 | If C<AutoClose> is specified, and the value is true, it will result in all |
395 | input and/or output filehandles being closed once C<anyuncompress> has |
396 | completed. |
397 | |
398 | This parameter defaults to 0. |
399 | |
e7d45986 |
400 | =item C<< BinModeOut => 0|1 >> |
25f0751f |
401 | |
402 | When writing to a file or filehandle, set C<binmode> before writing to the |
403 | file. |
404 | |
405 | Defaults to 0. |
406 | |
e7d45986 |
407 | =item C<< Append => 0|1 >> |
25f0751f |
408 | |
409 | TODO |
410 | |
e7d45986 |
411 | =item C<< MultiStream => 0|1 >> |
25f0751f |
412 | |
e7d45986 |
413 | If the input file/buffer contains multiple compressed data streams, this |
414 | option will uncompress the whole lot as a single data stream. |
25f0751f |
415 | |
e7d45986 |
416 | Defaults to 0. |
25f0751f |
417 | |
258133d1 |
418 | =item C<< TrailingData => $scalar >> |
419 | |
420 | Returns the data, if any, that is present immediately after the compressed |
421 | data stream once uncompression is complete. |
422 | |
423 | This option can be used when there is useful information immediately |
424 | following the compressed data stream, and you don't know the length of the |
425 | compressed data stream. |
426 | |
427 | If the input is a buffer, C<trailingData> will return everything from the |
428 | end of the compressed data stream to the end of the buffer. |
429 | |
430 | If the input is a filehandle, C<trailingData> will return the data that is |
431 | left in the filehandle input buffer once the end of the compressed data |
432 | stream has been reached. You can then use the filehandle to read the rest |
433 | of the input file. |
434 | |
435 | Don't bother using C<trailingData> if the input is a filename. |
436 | |
258133d1 |
437 | If you know the length of the compressed data stream before you start |
438 | uncompressing, you can avoid having to use C<trailingData> by setting the |
439 | C<InputLength> option. |
440 | |
25f0751f |
441 | =back |
442 | |
25f0751f |
443 | =head2 Examples |
444 | |
445 | To read the contents of the file C<file1.txt.Compressed> and write the |
446 | compressed data to the file C<file1.txt>. |
447 | |
448 | use strict ; |
449 | use warnings ; |
450 | use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ; |
451 | |
452 | my $input = "file1.txt.Compressed"; |
453 | my $output = "file1.txt"; |
454 | anyuncompress $input => $output |
455 | or die "anyuncompress failed: $AnyUncompressError\n"; |
456 | |
25f0751f |
457 | To read from an existing Perl filehandle, C<$input>, and write the |
458 | uncompressed data to a buffer, C<$buffer>. |
459 | |
460 | use strict ; |
461 | use warnings ; |
462 | use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ; |
463 | use IO::File ; |
464 | |
465 | my $input = new IO::File "<file1.txt.Compressed" |
466 | or die "Cannot open 'file1.txt.Compressed': $!\n" ; |
467 | my $buffer ; |
468 | anyuncompress $input => \$buffer |
469 | or die "anyuncompress failed: $AnyUncompressError\n"; |
470 | |
471 | To uncompress all files in the directory "/my/home" that match "*.txt.Compressed" and store the compressed data in the same directory |
472 | |
473 | use strict ; |
474 | use warnings ; |
475 | use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ; |
476 | |
477 | anyuncompress '</my/home/*.txt.Compressed>' => '</my/home/#1.txt>' |
478 | or die "anyuncompress failed: $AnyUncompressError\n"; |
479 | |
480 | and if you want to compress each file one at a time, this will do the trick |
481 | |
482 | use strict ; |
483 | use warnings ; |
484 | use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ; |
485 | |
486 | for my $input ( glob "/my/home/*.txt.Compressed" ) |
487 | { |
488 | my $output = $input; |
489 | $output =~ s/.Compressed// ; |
490 | anyuncompress $input => $output |
491 | or die "Error compressing '$input': $AnyUncompressError\n"; |
492 | } |
493 | |
494 | =head1 OO Interface |
495 | |
496 | =head2 Constructor |
497 | |
498 | The format of the constructor for IO::Uncompress::AnyUncompress is shown below |
499 | |
25f0751f |
500 | my $z = new IO::Uncompress::AnyUncompress $input [OPTS] |
501 | or die "IO::Uncompress::AnyUncompress failed: $AnyUncompressError\n"; |
502 | |
503 | Returns an C<IO::Uncompress::AnyUncompress> object on success and undef on failure. |
504 | The variable C<$AnyUncompressError> will contain an error message on failure. |
505 | |
506 | If you are running Perl 5.005 or better the object, C<$z>, returned from |
507 | IO::Uncompress::AnyUncompress can be used exactly like an L<IO::File|IO::File> filehandle. |
508 | This means that all normal input file operations can be carried out with |
509 | C<$z>. For example, to read a line from a compressed file/buffer you can |
510 | use either of these forms |
511 | |
512 | $line = $z->getline(); |
513 | $line = <$z>; |
514 | |
515 | The mandatory parameter C<$input> is used to determine the source of the |
516 | compressed data. This parameter can take one of three forms. |
517 | |
518 | =over 5 |
519 | |
520 | =item A filename |
521 | |
522 | If the C<$input> parameter is a scalar, it is assumed to be a filename. This |
523 | file will be opened for reading and the compressed data will be read from it. |
524 | |
525 | =item A filehandle |
526 | |
527 | If the C<$input> parameter is a filehandle, the compressed data will be |
528 | read from it. |
529 | The string '-' can be used as an alias for standard input. |
530 | |
25f0751f |
531 | =item A scalar reference |
532 | |
533 | If C<$input> is a scalar reference, the compressed data will be read from |
534 | C<$$output>. |
535 | |
536 | =back |
537 | |
538 | =head2 Constructor Options |
539 | |
25f0751f |
540 | The option names defined below are case insensitive and can be optionally |
541 | prefixed by a '-'. So all of the following are valid |
542 | |
543 | -AutoClose |
544 | -autoclose |
545 | AUTOCLOSE |
546 | autoclose |
547 | |
548 | OPTS is a combination of the following options: |
549 | |
550 | =over 5 |
551 | |
e7d45986 |
552 | =item C<< AutoClose => 0|1 >> |
25f0751f |
553 | |
554 | This option is only valid when the C<$input> parameter is a filehandle. If |
555 | specified, and the value is true, it will result in the file being closed once |
556 | either the C<close> method is called or the IO::Uncompress::AnyUncompress object is |
557 | destroyed. |
558 | |
559 | This parameter defaults to 0. |
560 | |
e7d45986 |
561 | =item C<< MultiStream => 0|1 >> |
25f0751f |
562 | |
25f0751f |
563 | Allows multiple concatenated compressed streams to be treated as a single |
564 | compressed stream. Decompression will stop once either the end of the |
565 | file/buffer is reached, an error is encountered (premature eof, corrupt |
566 | compressed data) or the end of a stream is not immediately followed by the |
567 | start of another stream. |
568 | |
569 | This parameter defaults to 0. |
570 | |
e7d45986 |
571 | =item C<< Prime => $string >> |
25f0751f |
572 | |
573 | This option will uncompress the contents of C<$string> before processing the |
574 | input file/buffer. |
575 | |
576 | This option can be useful when the compressed data is embedded in another |
577 | file/data structure and it is not possible to work out where the compressed |
578 | data begins without having to read the first few bytes. If this is the |
579 | case, the uncompression can be I<primed> with these bytes using this |
580 | option. |
581 | |
e7d45986 |
582 | =item C<< Transparent => 0|1 >> |
25f0751f |
583 | |
f6fd7794 |
584 | If this option is set and the input file/buffer is not compressed data, |
25f0751f |
585 | the module will allow reading of it anyway. |
586 | |
f6fd7794 |
587 | In addition, if the input file/buffer does contain compressed data and |
588 | there is non-compressed data immediately following it, setting this option |
589 | will make this module treat the whole file/bufffer as a single data stream. |
590 | |
25f0751f |
591 | This option defaults to 1. |
592 | |
e7d45986 |
593 | =item C<< BlockSize => $num >> |
25f0751f |
594 | |
595 | When reading the compressed input data, IO::Uncompress::AnyUncompress will read it in |
596 | blocks of C<$num> bytes. |
597 | |
598 | This option defaults to 4096. |
599 | |
e7d45986 |
600 | =item C<< InputLength => $size >> |
25f0751f |
601 | |
602 | When present this option will limit the number of compressed bytes read |
603 | from the input file/buffer to C<$size>. This option can be used in the |
604 | situation where there is useful data directly after the compressed data |
605 | stream and you know beforehand the exact length of the compressed data |
606 | stream. |
607 | |
608 | This option is mostly used when reading from a filehandle, in which case |
609 | the file pointer will be left pointing to the first byte directly after the |
610 | compressed data stream. |
611 | |
25f0751f |
612 | This option defaults to off. |
613 | |
e7d45986 |
614 | =item C<< Append => 0|1 >> |
25f0751f |
615 | |
616 | This option controls what the C<read> method does with uncompressed data. |
617 | |
618 | If set to 1, all uncompressed data will be appended to the output parameter |
619 | of the C<read> method. |
620 | |
621 | If set to 0, the contents of the output parameter of the C<read> method |
622 | will be overwritten by the uncompressed data. |
623 | |
624 | Defaults to 0. |
625 | |
e7d45986 |
626 | =item C<< Strict => 0|1 >> |
25f0751f |
627 | |
25f0751f |
628 | This option controls whether the extra checks defined below are used when |
629 | carrying out the decompression. When Strict is on, the extra tests are |
630 | carried out, when Strict is off they are not. |
631 | |
632 | The default for this option is off. |
633 | |
258133d1 |
634 | =item C<< RawInflate => 0|1 >> |
635 | |
636 | When auto-detecting the compressed format, try to test for raw-deflate (RFC |
637 | 1951) content using the C<IO::Uncompress::RawInflate> module. |
638 | |
639 | The reason this is not default behaviour is because RFC 1951 content can |
640 | only be detected by attempting to uncompress it. This process is error |
641 | prone and can result is false positives. |
642 | |
643 | Defaults to 0. |
644 | |
25f0751f |
645 | =back |
646 | |
647 | =head2 Examples |
648 | |
649 | TODO |
650 | |
651 | =head1 Methods |
652 | |
653 | =head2 read |
654 | |
655 | Usage is |
656 | |
657 | $status = $z->read($buffer) |
658 | |
659 | Reads a block of compressed data (the size the the compressed block is |
660 | determined by the C<Buffer> option in the constructor), uncompresses it and |
661 | writes any uncompressed data into C<$buffer>. If the C<Append> parameter is |
662 | set in the constructor, the uncompressed data will be appended to the |
663 | C<$buffer> parameter. Otherwise C<$buffer> will be overwritten. |
664 | |
665 | Returns the number of uncompressed bytes written to C<$buffer>, zero if eof |
666 | or a negative number on error. |
667 | |
668 | =head2 read |
669 | |
670 | Usage is |
671 | |
672 | $status = $z->read($buffer, $length) |
673 | $status = $z->read($buffer, $length, $offset) |
674 | |
675 | $status = read($z, $buffer, $length) |
676 | $status = read($z, $buffer, $length, $offset) |
677 | |
678 | Attempt to read C<$length> bytes of uncompressed data into C<$buffer>. |
679 | |
680 | The main difference between this form of the C<read> method and the |
681 | previous one, is that this one will attempt to return I<exactly> C<$length> |
682 | bytes. The only circumstances that this function will not is if end-of-file |
683 | or an IO error is encountered. |
684 | |
685 | Returns the number of uncompressed bytes written to C<$buffer>, zero if eof |
686 | or a negative number on error. |
687 | |
25f0751f |
688 | =head2 getline |
689 | |
690 | Usage is |
691 | |
692 | $line = $z->getline() |
693 | $line = <$z> |
694 | |
695 | Reads a single line. |
696 | |
258133d1 |
697 | This method fully supports the use of of the variable C<$/> (or |
698 | C<$INPUT_RECORD_SEPARATOR> or C<$RS> when C<English> is in use) to |
699 | determine what constitutes an end of line. Paragraph mode, record mode and |
700 | file slurp mode are all supported. |
25f0751f |
701 | |
25f0751f |
702 | =head2 getc |
703 | |
704 | Usage is |
705 | |
706 | $char = $z->getc() |
707 | |
708 | Read a single character. |
709 | |
710 | =head2 ungetc |
711 | |
712 | Usage is |
713 | |
714 | $char = $z->ungetc($string) |
715 | |
25f0751f |
716 | =head2 getHeaderInfo |
717 | |
718 | Usage is |
719 | |
720 | $hdr = $z->getHeaderInfo(); |
721 | @hdrs = $z->getHeaderInfo(); |
722 | |
723 | This method returns either a hash reference (in scalar context) or a list |
724 | or hash references (in array context) that contains information about each |
725 | of the header fields in the compressed data stream(s). |
726 | |
25f0751f |
727 | =head2 tell |
728 | |
729 | Usage is |
730 | |
731 | $z->tell() |
732 | tell $z |
733 | |
734 | Returns the uncompressed file offset. |
735 | |
736 | =head2 eof |
737 | |
738 | Usage is |
739 | |
740 | $z->eof(); |
741 | eof($z); |
742 | |
25f0751f |
743 | Returns true if the end of the compressed input stream has been reached. |
744 | |
25f0751f |
745 | =head2 seek |
746 | |
747 | $z->seek($position, $whence); |
748 | seek($z, $position, $whence); |
749 | |
25f0751f |
750 | Provides a sub-set of the C<seek> functionality, with the restriction |
751 | that it is only legal to seek forward in the input file/buffer. |
752 | It is a fatal error to attempt to seek backward. |
753 | |
25f0751f |
754 | The C<$whence> parameter takes one the usual values, namely SEEK_SET, |
755 | SEEK_CUR or SEEK_END. |
756 | |
757 | Returns 1 on success, 0 on failure. |
758 | |
759 | =head2 binmode |
760 | |
761 | Usage is |
762 | |
763 | $z->binmode |
764 | binmode $z ; |
765 | |
766 | This is a noop provided for completeness. |
767 | |
768 | =head2 opened |
769 | |
770 | $z->opened() |
771 | |
772 | Returns true if the object currently refers to a opened file/buffer. |
773 | |
774 | =head2 autoflush |
775 | |
776 | my $prev = $z->autoflush() |
777 | my $prev = $z->autoflush(EXPR) |
778 | |
779 | If the C<$z> object is associated with a file or a filehandle, this method |
780 | returns the current autoflush setting for the underlying filehandle. If |
781 | C<EXPR> is present, and is non-zero, it will enable flushing after every |
782 | write/print operation. |
783 | |
784 | If C<$z> is associated with a buffer, this method has no effect and always |
785 | returns C<undef>. |
786 | |
787 | B<Note> that the special variable C<$|> B<cannot> be used to set or |
788 | retrieve the autoflush setting. |
789 | |
790 | =head2 input_line_number |
791 | |
792 | $z->input_line_number() |
793 | $z->input_line_number(EXPR) |
794 | |
25f0751f |
795 | Returns the current uncompressed line number. If C<EXPR> is present it has |
796 | the effect of setting the line number. Note that setting the line number |
797 | does not change the current position within the file/buffer being read. |
798 | |
799 | The contents of C<$/> are used to to determine what constitutes a line |
800 | terminator. |
801 | |
25f0751f |
802 | =head2 fileno |
803 | |
804 | $z->fileno() |
805 | fileno($z) |
806 | |
d54256af |
807 | If the C<$z> object is associated with a file or a filehandle, C<fileno> |
808 | will return the underlying file descriptor. Once the C<close> method is |
809 | called C<fileno> will return C<undef>. |
25f0751f |
810 | |
d54256af |
811 | If the C<$z> object is is associated with a buffer, this method will return |
812 | C<undef>. |
25f0751f |
813 | |
814 | =head2 close |
815 | |
816 | $z->close() ; |
817 | close $z ; |
818 | |
25f0751f |
819 | Closes the output file/buffer. |
820 | |
25f0751f |
821 | For most versions of Perl this method will be automatically invoked if |
822 | the IO::Uncompress::AnyUncompress object is destroyed (either explicitly or by the |
823 | variable with the reference to the object going out of scope). The |
824 | exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In |
825 | these cases, the C<close> method will be called automatically, but |
826 | not until global destruction of all live objects when the program is |
827 | terminating. |
828 | |
829 | Therefore, if you want your scripts to be able to run on all versions |
830 | of Perl, you should call C<close> explicitly and not rely on automatic |
831 | closing. |
832 | |
833 | Returns true on success, otherwise 0. |
834 | |
835 | If the C<AutoClose> option has been enabled when the IO::Uncompress::AnyUncompress |
836 | object was created, and the object is associated with a file, the |
837 | underlying file will also be closed. |
838 | |
e7d45986 |
839 | =head2 nextStream |
840 | |
841 | Usage is |
842 | |
843 | my $status = $z->nextStream(); |
844 | |
845 | Skips to the next compressed data stream in the input file/buffer. If a new |
258133d1 |
846 | compressed data stream is found, the eof marker will be cleared and C<$.> |
847 | will be reset to 0. |
e7d45986 |
848 | |
849 | Returns 1 if a new stream was found, 0 if none was found, and -1 if an |
850 | error was encountered. |
851 | |
852 | =head2 trailingData |
853 | |
854 | Usage is |
855 | |
856 | my $data = $z->trailingData(); |
857 | |
258133d1 |
858 | Returns the data, if any, that is present immediately after the compressed |
859 | data stream once uncompression is complete. It only makes sense to call |
860 | this method once the end of the compressed data stream has been |
861 | encountered. |
862 | |
863 | This option can be used when there is useful information immediately |
864 | following the compressed data stream, and you don't know the length of the |
865 | compressed data stream. |
866 | |
867 | If the input is a buffer, C<trailingData> will return everything from the |
868 | end of the compressed data stream to the end of the buffer. |
869 | |
870 | If the input is a filehandle, C<trailingData> will return the data that is |
871 | left in the filehandle input buffer once the end of the compressed data |
872 | stream has been reached. You can then use the filehandle to read the rest |
873 | of the input file. |
874 | |
875 | Don't bother using C<trailingData> if the input is a filename. |
876 | |
258133d1 |
877 | If you know the length of the compressed data stream before you start |
878 | uncompressing, you can avoid having to use C<trailingData> by setting the |
879 | C<InputLength> option in the constructor. |
e7d45986 |
880 | |
25f0751f |
881 | =head1 Importing |
882 | |
883 | No symbolic constants are required by this IO::Uncompress::AnyUncompress at present. |
884 | |
885 | =over 5 |
886 | |
887 | =item :all |
888 | |
889 | Imports C<anyuncompress> and C<$AnyUncompressError>. |
890 | Same as doing this |
891 | |
892 | use IO::Uncompress::AnyUncompress qw(anyuncompress $AnyUncompressError) ; |
893 | |
894 | =back |
895 | |
896 | =head1 EXAMPLES |
897 | |
25f0751f |
898 | =head1 SEE ALSO |
899 | |
258133d1 |
900 | 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::AnyInflate> |
25f0751f |
901 | |
902 | L<Compress::Zlib::FAQ|Compress::Zlib::FAQ> |
903 | |
904 | L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>, |
905 | L<Archive::Tar|Archive::Tar>, |
906 | L<IO::Zlib|IO::Zlib> |
907 | |
25f0751f |
908 | =head1 AUTHOR |
909 | |
cb7abd7f |
910 | This module was written by Paul Marquess, F<pmqs@cpan.org>. |
25f0751f |
911 | |
25f0751f |
912 | =head1 MODIFICATION HISTORY |
913 | |
914 | See the Changes file. |
915 | |
916 | =head1 COPYRIGHT AND LICENSE |
25f0751f |
917 | |
d54256af |
918 | Copyright (c) 2005-2008 Paul Marquess. All rights reserved. |
25f0751f |
919 | |
920 | This program is free software; you can redistribute it and/or |
921 | modify it under the same terms as Perl itself. |
922 | |