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