7 Get memGunzip & memGzip to set $gzerrno
11 Export memGunzip, memGzip and zlib_version on demand
15 This sample was using IO::Uncompress::AnyInflate. Much better to
16 use IO::Uncompress::AnyUncompress.
20 * IO::Compress::AnyUncompress
21 Added support for lzma_alone & xz.
25 * IO::Compress - Makefile.PL
30 * IO::Compress::Base.pm
31 - Less warnnings when reading from a closed filehandle.
33 - Fixed minor typo in an error message.
37 The PREREQ_PM dependency on Scalar::Util got dropped when
38 IO-Compress was created in 2.017.
41 * IO::Compress::Zip.pm
42 - Removed restriction that zip64 is only supported in streaming
44 - The "version made by" and "extract" fields in the zip64 end
45 central record were swapped.
46 - In the End Central Header record the "offset to the start of the
47 central directory" will now always be set to 0xFFFFFFFF when
49 - In the End Central Header record the "total entries in the
50 central directory" field will be set to 0xFFFF if zip64 is
51 enabled AND there are more than 0xFFFF entries present.
53 * IO::Uncompress::Unzip.pm
54 - Don't consume lots of memory when walking a zip file. This makes
55 life more bearable when dealing with zip64.
58 - documented that memGunzip cannot cope with concatenated gzip data
61 * Changed test harness so that it can cope with PERL5OPT=-MCarp=verbose
64 * IO::Compress::Gzip::Constants.pm
65 - GZIP_FEXTRA_MAX_SIZE was set to 0xFF. Should be 0xFFFF. This
66 issue came up when attempting to unzip a file created by MS
71 * IO::Uncompress::Base.pm
72 - Fixed problem with LimitOutput where a call to uncompress
73 created more uncompressed output, but didn't consume any of
74 the input buffer. The symptom is the underlying compression
75 library (zlib or bzip2) thinks the input stream is corrupt.
80 * IO::Uncompress::Adapter::Bunzip2
81 - Fixed problem with EOF check.
85 * IO::Unompress::Bunzip2
86 - The interface to Compress-Raw-Bzip2 now uses the new LimitOutput
87 feature. This will make all of the bzip2-related IO-Compress modules
88 less greedy in their memory consumption.
91 - Fixed exTime & exUnix2
93 - Fixed 'Use of uninitialized value in pack' warning when using
98 * Merged IO-Compress-Base, IO-Compress-Bzip2, IO-Compress-Zlib &
99 Compress-Zlib into IO-Compress.
101 * The interface to Compress-Raw-Zlib now uses the new LimitOutput
102 feature. This will make all of the zlib-related IO-Compress modules
103 less greedy in their memory consumption.
105 * Removed MAN3PODS from Makefile.PL
107 * A few changes to get the test harness to work on VMS courtesy of
110 * IO::Compress::Base & IO::Uncompress::Base
111 Downgraded some croaks in the constructors to just set $! (by letting
112 the code attempt to open a file and fail).
113 This makes the behavior more consistent to a standard open.
116 * IO::Uncompress::Base
117 Doing a seek with MultiStream could drop some of the uncompressed
121 - Fixed problem with the uncompressed & uncompressed fields when
122 zip64 is enabled. They were set to 0x0000FFFF instead of
123 0xFFFFFFFF. Also the ZIP64 extra field was 4 bytes short.
124 Problem spotted by Dino Chiesa.
126 * IO::Uncompress::Unzip
127 - use POSIX::mktime instead of Time::Local::timelocal to convert
128 the zip DOS time field into Unix time.
131 - Documented Compress::Zlib::zlib_version()
134 2.015 3 September 2008
137 Backout changes made in 2.014
139 2.014 2 September 2008
142 Updated to check for indirect dependencies.
147 - Allow IO::Compress::Base::Parameters::parse to accept an
148 IO::Compress::Base::Parameters object.
153 - Silenced an uninitialised value warning when reading a line
154 at a time from a zip file where the content uses ZIP_CM_STORE.
155 [Problem spotted & fixed by Jeff Holt]
157 * IO::Compress::Base & IO::Uncompress::Base
158 - local-ise $!, $? et al in the DESTROY methods.
163 - Fixed problem that prevented the creation of a zip file that
164 contained more than one compression method.
166 * IO::Compress::Base::Common
167 - The private Validator class in this module clashes with another
168 CPAN module. Moved Validator into the IO::Compress::Base::Common
172 * IO::Uncompress::Unzip
173 - Print an error message if the zip file contains a
174 member compressed with bzip2 and IO::Uncompress::Bunzip2 is
176 - Could not cope with mixed compression zip files. For example a
177 zip file that contains both STORED and DEFLATED content.
182 * Fixed problem that meant Perl 5.10 could not upgrade this module.
187 * Removed the alpha status from File::GlobMapper
190 When writing output never output a zero length buffer.
191 Done to improve interoperability with other tied filenandle
194 * Changed IO::Uncompress::Base to not use the offset parameter of
195 the read method when reading from a filehandle.
197 The object returned from Net::FTP::retr implements a non-standard
198 read method. The third parameter is used for a timeout value
199 rather than an offset.
202 * Changed IO::Uncompress::Base to not use the eof method when
203 reading from a filehandle.
205 The object returned from Net::FTP::retr implements both the read
206 method and the eof method. Unfortunately the implementation of
207 the read method uses non-buffered IO (by using sysread) while
208 the eof method uses buffered IO. Mixing buffered and non-buffered
209 IO results in data corruption.
213 - Added exUnix2 option to allow storing of UID & GID.
214 - When running on a Unix derivative the ExtAttr option now defaults
215 to the equivalent of 0666. For all other systems the default
219 - Minor documentation issue with flush.
223 2.008 2 November 2007
225 * Minor documentation changes in README
227 * t/compress/truncate.pl
230 * IO::Compress::Gzip::Constants.pm
231 Tidied up the character classes used to defined invalid
232 FNAME & FCOMMENT fields for EBCDIC.
235 lib/Compress/Zlib.pm -- 1.x Backward Compatability issues
236 gzclose - documented return value was wrong, should be 0 for ok.
237 gzflush - return value didn't match 1.x, should return 0 if ok.
238 [rt.cpan.org #29215] and Debian bug #440943 http://bugs.debian.org/440943
240 2.006 1 September 20007
243 Added INSTALLDIRS directive to install as a core module when built
246 * IO::Uncompress::RawDeflate
248 - Fixed export problem - "$RawDeflateError" and "rawdeflate" were
249 not being exported with ":all".
253 Fixed crc32 and adler32 tests in to remove ascii assumption.
255 - lib/Compress/Zlib.pm
256 Make gzreadline not support $/, just like in Compress::Zlib 1.x
257 Folk who want $/ with readline support can get it in
258 IO::Uncompress::Gunzip. [rt.cpan.org #28663] and
259 Debian bug #435656 http://bugs.debian.org/435656
264 * Stephen Turner reported a problem when using IO::Uncompress::Gunzip
265 with XML::Parser. Turns out there were two issues.
267 Firstly an IO::Uncompress object isn't an IO::Handle. It is now.
269 Secondly the implementation of "read" wasn't honouring this
271 SCALAR will be grown or shrunk to the length actually read.
273 In particular it didn't do the right thing on EOF.
276 * IO::Compress::Gzip & IO::Uncompress::Gunzip
278 - RFC1952 says that the FNAME & FCOMMENT header fields must be ISO
279 8859-1 (LATIN-1) characters. The code can optionally police this.
280 Added a fix for this logic when running on EBCDIC.
283 Added info about removing Compress::Zlib version 1, before
284 installing version 2.
288 * Made seek less wasteful of memory.
292 - Added Zip64 documentation.
294 - Fixed extended timestamp.
295 Creation time isn't available in Unix so only store the
296 modification time and the last access time in the extended field.
300 - Added ExtAttr option to control the value of the "external file
301 attributes" field in the central directory.
303 - Added Unix2 extended attribute ("Ux").
304 This stores the UID & GID.
308 - Fixed 050interop-gzip.t for Windows
310 * IO::Compress::Bzip2
312 - Fixed 050interop-bzip2.t for Windows
316 - rewrote memGzip using IO::Compress::Gzip::gzip
320 * Added explicit version checking
322 2.002 29 December 2006
324 * Documentation updates.
326 * Added IO::Handle to the ISA test in isaFilehandle
328 * Add an explicit use_ok test for Scalar::Util in the test harness.
329 The error message reported by 01misc implied the problem was
331 Also explictly check that 'dualvar' is available.
334 - Fix append mode with gzopen.
337 - Allow gzopen to read from and write to a scalar reference.
339 2.001 1 November 2006
341 * Remove beta status.
343 2.000_14 26 October 2006
345 * IO::Uncompress::Base
346 Added support for $/ in record mode
348 * IO::Uncompress::Base
349 The readline interface was substantially slower than the 1.x
350 equivalent. This has now been sorted.
351 Thanks to Andreas J. Koenig for spotting the problem.
353 * IO::Uncompress::AnyUncompress
354 Added IO::Uncompress::Lzf to the list of supported uncompresors.
356 * IO::Uncompress::Base
357 Added TrailingData to one-shot interface.
359 * IO::Uncompress::AnyUncompress
360 Remove raw-deflate (RFC1951) from the default list of compressors
362 It can still be included if the new RawInflate parameter is
364 This change was made because the only way to tell if content is
365 raw-deflate is to attempt to uncompress it - a few false positives
366 have popped up recently, which suggests that auto-detecting raw
367 deflate is far from perfect.
368 The equivalent change has been made to IO::Uncompress::AnyInflate.
371 * Don't check that filehandles are writable. It would seem that
372 "-w *STDOUT" on windows returns false.
375 * IO::Uncompress::Deflate
376 Beefed up the magic signature check. Means less false positives
377 when auto-detecting the compression type.
379 * IO::Uncompress::UnZip
380 Tighten up the zip64 extra field processing to cope with the case
381 wheere only some of the local header fields are superceeded.
383 * IO::Uncompress::AnyInflate
384 Remove raw-deflate (RFC 1951) from the default list of compressors
386 It can still be included if the new RawInflate parameter is
388 This change was made because the only way to tell if content is
389 raw-deflate is to attempt to uncompress it - a few false positives
390 have popped up recently, which suggests that auto-detecting raw
391 deflate is far from perfect.
392 The equivalent change has been made to IO::Uncompress::AnyUncompress.
395 2.000_13 20 June 2006
397 * Store compress & uncompressed sizes as 64-bit.
399 * For one-shot uncompression, like this
401 unzip "some.zip" => \@a, MultiStream => 1;
403 Push each uncompressed stream from "some.zip" onto @a.
405 * Added IO::Compress::Base::FilterEnvelope
407 * Added IO::Uncompress::Base::nextStream
409 * The '-' filehandle now maps to either *STDIN or *STDOUT.
410 This keeps mod_perl happier. Was using these before
415 * Preliminary support for reading zip files with zip64 members.
419 * Moved the code for creating and parsing the gzip extra field into
420 IO::Compress::Zlib::Extra.pm so that IO::Compress::Zip &
421 IO::Uncompress::Unzip can use it as well.
423 * Added ExtraFieldLocal & ExtraFieldCentral options to IO::Compress::Zip.
424 These allow the creation of user-defined extra fields in the local
425 and central headers, just like the ExtraField option in
428 * Moved the zip constants into IO::Compress::Zip::Constants
430 * Added exTime option to IO::Compress::Zip.
431 This allows creation of the extended timestamp extra field.
433 * Added Minimal option to IO::Compress::Zip.
434 This disables the creation of all extended fields.
436 * Added TextFlag option to IO::Compress::Zip.
438 * Documented Comment and ZipComment options in IO::Compress::Zip.
441 Fixed gzread to zap the output buffer to an empty string when zero
442 bytes are requested. This matches the behaviour of C::Z 1.x
444 2.000_11 10 April 2006
446 * Transparent + InputLength made more robust where input data is not
449 * Updated Documentation for zip modules.
451 * Changed IO::Compress::Zip 'Store' option to 'Method' and added
452 symbolic constants ZIP_CM_STORE, ZIP_CM_DEFLATE and ZIP_CM_BZIP2 to
453 allow the compression method to be picked by the user.
455 * Added support to allow bzip2 compressed data to be written/read
456 with IO::Compress::Zip and IO::Uncompress::Unzip.
458 * Beefed up 050interop-gzip.t to check that the external gzip command
459 works as expected before starting the tests. This means that
460 this test harness will just be skipped on problematic systems.
462 * Merged core patch 27565 from Steve Peters. This works around a
463 problem with gzip on OpenBSD where it doesn't seem to like
464 compressing files < 10 bytes long.
466 * Beefed up 050interop-bzip2.t to check that the external bzip2 command
467 works as expected before starting the tests. This means that
468 this test harness will just be skipped on problematic systems.
470 2.000_10 13 March 2006
472 * AnyUncompress doesn't assume that IO-Compress-Zlib is installed any
475 * Documentation updates.
478 Changed gzread so that its behaviour matches C::Z::gzread 1.x if it
479 is called after eof. In this case it will write an empty string
480 into the output parameter. This change is solely for backward
481 compatability reasons.
483 2.000_09 3 March 2006
487 2.000_08 2 March 2006
489 * Split IO::Compress::Base into its own distribution.
491 * Split IO::Compress::Bzip2 into its own distribution.
493 * Added opened, autoflush and input_line_number.
495 * Beefed up support for $.
497 * Split IO::Compress::Zlib into its own distribution.
499 * Beefed up support for zip/unzip
501 * Breakout zlib specific code into separate modules.
503 * Limited support for reading/writing zip files
505 2.000_06 5 October 2005
507 * Added eof parameter to Compress::Zlib::inflate method.
509 * Fixed issue with 64-bit
511 2.000_05 4 October 2005
513 * Renamed IO::* to IO::Compress::* & IO::Uncompress::*
515 2.000_04 23 September 2005
517 * Fixed some more non-portable test that were failing on VMS.
519 * fixed problem where error messages in the oneshot interface were
522 2.000_03 12 September 2005
524 * Fixed some non-portable test that were failing on VMS.
526 * Fixed export of zlib constants from the IO::* classes
528 2.000_02 6 September 2005
530 * Split Append mode into Append and Merge
532 * Fixed typos in the documentation.
536 * Added libscan to Makefile.PL
538 * Added InputLength for IO::Gunzip et al
540 2.000_01 22 August 2005
542 * Fixed VERSION in Compress::Gzip::Constants
544 * Removed Compress::Gzip::Info from the distribution.
546 2.000_00 21 August 2005
548 * First Beta relase of Compress::zlib rewrite.
550 Compress-Zlib version 1 Changes
552 1.38 - 6 September 2005
554 * Integrate core change 25304 -- Symbian Update
556 * Added libscan to Makefile.PL
558 1.37 - 12 August 2005
560 * Change to t/03examples.t for VMS from Abe Timmerman
564 * Renamed zlib-src-1.2.3 to zlib-src to help VMS
566 * Fixed Makefile.PL for VMS
568 * Fixed t/03examples.t for VMS
570 * Added a couple of notes about incompatibility with Unix compress.
574 * Updated zlib source to 1.2.3
576 * Fixed problem with where two calls to gzclose would hang the debugger.
577 See https://rt.cpan.org/Ticket/Display.html?id=13789
579 * Added code from Alexey Tourbin to use XSLoader when available,
580 and DynaLoader otherwise.
582 * Documented that the compress & uncompress functions were not
583 the same as the Unix utilities of the same name.
585 * Fixed 05gzsetp -- it left a temp file hanging around.
587 * Integrate core change 24787 - SvUPGRADE returns void in blead
589 * Integrate core change 24788 - Makefile.PL adjustments for the core
592 1.34 - 30 January 2005
594 * Fixed typo in the README
596 * Fixed examples.t on Win32 where paths have embedded whitespace.
598 * Fix for Cygwin and core integration from Jos I. Boumans
600 * Upgrade zlib source to 1.2.2
602 1.33 - 14 January 2004
604 * Reworked Makefile.PL to avoid creating a private copy of zlib.
605 This both simplifies the build, plus it makes life easier for VMS.
607 * Patches for Makefile.PL to get it to work on VMS supplied by
610 * memGunzip has very slow on FreeBSD. Turns out to be down to
611 the way realloc works on FreeBSD. Changed both inflate & deflate
612 to use exponentially increasing buffer sizes when they need to
613 realloc. Thanks to Peter Jeremy for the lowdown on FreeBSD
616 1.32 - 26 November 2003
618 * Steve Hay reported a problem on rt.cpan.org with Windows and
619 MSCV++ 6.0 where the source from the zlib directory was getting
620 installed with the rest of the module.
621 https://rt.cpan.org/Ticket/Display.html?id=1741
623 This has been fixed by renaming the "zlib" directory to "zlib-src"
624 thus avoiding a conflict with the name of this Perl module.
626 * Fixed a bug in the inflate method where the input buffer is an
627 lvalue (via substr). Problem & solution reported by Salvador Fandiqo.
629 * Tightened up the logic in Makefile.PL when BUILD_ZLIB is
630 True. Issue spotted by Ralf S. Engelschall.
632 1.31 - 29 October 2003
634 * Reinstated the creation of .bak files - $^I seems to need a
635 backup file on Windows. For OpenVMS, the extenstion _bak is used.
637 1.30 - 28 October 2003
639 * Bundled a sub-set of the zlib source with the module and changed
640 the default make behaviour to build with the included zlib source.
641 The previous behaviour of using a pre-built zlib library is
642 still available for those that want it.
644 * Added prototypes to the subs in Zlib.pm that didn't already have
645 them. Patch from Ed Avis.
647 * No .bak files are created by Makefile.PL any more - this keep
648 distclean much happier. Patch suggested by Ed Avis.
649 This also fixes a similar problem reported by Dr. Martin Zinser
652 * Documentation for some of the gz functions updated.
654 * Format strings modified in DispStream to keep OpenVMS happy.
655 Problem reported by Dr. Martin Zinser.
660 * Makefile.PL now displays a warning about not installing
661 Compress::Zlib via the CPAN shell.
663 * Fix to allow intermingling of gzread & gzreadline - patch
664 supplied by Doug Perham.
666 * memGunzip will silently now work if the gzip trailer is
667 missing. Some HTTP Origin Servers seem to leave it out.
671 * Tests 148 & 150 from t/02zlib.t were failing on redhat 9.
673 * Added a few words about the problems with Mac OS X to the README file.
677 * Fixed bug in gzopen where $gzerrno wasn't being set correctly.
678 The symptom was $gzerrno was set to Z_MEM_ERROR although the file
679 was opened ok. If gzopen failed, $gzerrno was being set correctly.
680 This problem wasn't spotted before because the typical test
681 to determine whether gzopen passed or failed was to check its
684 1.19 - 31 October 2002
686 * fixed a problem with t/02zlib.t that was failing with redhat 8.
688 1.18 - 24 October 2002
690 * fixed a Win32 problem in t/02zlib.t by changing sysread to read.
692 * zlib 1.0.5 & older doesn't have gzsetparams & gzeof. Added a new
693 variable to config.in to flag an old version of zlib. Split
694 out the tests for gzsetparams into t/05gzsetp.t
698 * Moved the test to check the versions of libz & zlib.h into a separate
699 file and added troubleshooting notes to README.
701 * In gzopen, only attempt to call "tell" for normal files.
703 * Fixed to work in taint mode.
705 * Broke changes out of README into Changes file.
707 * Replaced internal use of Z_PARTIAL_FLUSH symbol with Z_SYNC_FLUSH.
708 zlib.h says /* will be removed, use Z_SYNC_FLUSH instead */
710 1.16 - 13 December 2001
712 * Fixed bug in Makefile.PL that stopped "perl Makefile.PL PREFIX=..."
715 1.15 - 4th December 2001
717 * Changes a few types to get the module to build on 64-bit Solaris
719 * Changed the up/downgrade logic to default to the older constructs, and
720 to only call a downgrade if specifically requested. Some older versions
721 of Perl were having problems with the in-place edit.
723 * added the new XS constant code.
725 1.14 - 27th August 2001
727 * Memory overwrite bug fixed in "inflate". Kudos to Rob Simons for
728 reporting the bug and to Anton Berezin for fixing it for me.
730 1.13 - 31st June 2001
732 * Make sure config.in is consistant when released.
734 1.12 - 28th April 2001
736 * Modified Makefile.PL to only enable the warnings pragma if
737 using perl 5.6.1 or better.
739 1.11 - 17th February 2001
741 * Added logic in Makefile.PL to toggle between using $^W and
742 the warnings pragma in the module.
744 * The module, the examples & the test harness are now all strict
747 1.10 - 5th February 2001
749 * fixed a bug in memGunzip. Used Z_ERR instead of Z_DATA_ERROR.
751 1.09 - 15th January 2001
753 * Silenced a few compiler warnings.
755 * Updated zlib home site in README & Zlib.pm to www.info-zip.org
757 * Minor typo in Zlib.pm - a link used AUTHORS instead of AUTHOR
758 -- spotted by Frank Martini.
760 * Mention Archive::Zip
762 * added memGunzip. This is largely based on code provided by Jim Leonard.
764 * $deflate->flush can now take an optional parameter. Valid
765 values are Z_NO_FLUSH, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, Z_FULL_FLUSH
766 and Z_FINISH. The default is Z_FINISH.
770 * uncompress was clobbering its input parameter. Now it doesn't.
771 This bug was spotted by Deven T. Corzine.
773 * If a variable that only ever contained a number was given
774 to compress or deflate, it would not be compressed properly. Now
775 it will be coerced to a string and then compressed. This bug
776 was spotted by Deven T. Corzine.
780 * ANSI-ified the static functions in Zlib.xs
782 * Added the ability to build zlib along with the module.
783 This feature is 90% based on a Makefile provided by Gurusamy
788 * Fixed a nasty problem where inflate could truncate the data
789 returned. Thanks to Douglas Thomson <dougt@mugc.cc.monash.edu.au>
790 for both spotting the problem and fixing the bug.
792 * Added a note about the undocumented features in zlib that are
793 required when accessing zip files.
795 * gzclose will now get called automatically when the gzip object is
800 * Previous release used newSVpvn, which doesn't exist in 5.004_04
801 or earlier. Changed to use newSVpv instead.
803 * The module needs Perl 5.004 or better, so updated the version
804 checking in Zlib.pm and Makefile.PL
808 * Bug 19990527.001: compress(undef) core dumps -- Fixed.
812 * Updated to use the new PL_ symbols.
813 Means the module can be built with Perl 5.005_5*
817 * The return codes for gzread, gzreadline and gzwrite were
818 documented incorrectly as returning a status code.
820 * The test harness was missing a "gzclose". This caused problem
821 showed up on an amiga. Thanks to Erik van Roode for reporting
824 * Patched zlib.t for OS/2. Thanks to Ilya Zakharevich for the patch.
828 * A number of fixes to the test suite and the example scripts to
829 allow them to work under win32. All courtesy of Gurusamy
834 * Fixed crc32 & adler32. They were very broken.
836 * The following functions can now take a scalar reference in
837 place of a scalar for their buffer parameters:
846 This should mean applications that make use of the module don't
847 have to copy large buffers around.
850 * Normally the inflate method consumes I<all> of the input buffer
851 before returning. The exception to this is when inflate detects
852 the end of the stream (Z_STREAM_END). In this case the input
853 buffer need not be completely consumed. To allow processing of
854 file formats that embed a deflation stream (e.g. zip, gzip),
855 the inflate method now sets the buffer parameter to be what
856 remains after inflation.
858 When the return status is Z_STREAM_END, it will be what remains
859 of the buffer (if any) after deflation. When the status is Z_OK
860 it will be an empty string.
862 This change means that the buffer parameter must be a lvalue.
864 * Fixed crc32 and adler32. They were both very broken.
866 * Added the Compress::Zlib::memGzip function.
868 0.5 - Confirmed that no changes were necessary for zlib 1.0.3, or 1.0.4.
870 The optional parameters for deflateInit and inflateInit can now
871 be specified as an associative array in addition to a reference
872 to an associative array. They can also accept the -Name
875 gzopen can now optionally take a reference to an open
876 filehandle in place of a filename. In this case it will call
879 Added gzstream example script.
881 0.4 - Upgrade to support zlib 0.99
883 Added dictionary interface.
885 Fixed bug in gzreadline - previously it would keep returning
886 the same buffer. This bug was reported by Helmut Jarausch
888 Removed dependency to zutil.h and so dropped support for
890 DEF_MEM_LEVEL (use MAX_MEM_LEVEL instead)
891 DEF_WBITS (use MAX_WBITS instead)
893 0.3 - Added prototype specification.
895 0.2 - Fixed a minor allocation problem in Zlib.xs
897 0.1 - first alpha release. 2nd October 1995