6 * IO::Uncompress::Base.pm
7 - Fixed problem with LimitOutput where a call to uncompress
8 created more uncompressed output, but didn't consume any of
9 the input buffer. The symptom is the underlying compression
10 library (zlib or bzip2) thinks the input stream is corrupt.
15 * IO::Uncompress::Adapter::Bunzip2
16 - Fixed problem with EOF check.
20 * IO::Unompress::Bunzip2
21 - The interface to Compress-Raw-Bzip2 now uses the new LimitOutput
22 feature. This will make all of the bzip2-related IO-Compress modules
23 less greedy in their memory consumption.
26 - Fixed exTime & exUnix2
28 - Fixed 'Use of uninitialized value in pack' warning when using
33 * Merged IO-Compress-Base, IO-Compress-Bzip2, IO-Compress-Zlib &
34 Compress-Zlib into IO-Compress.
36 * The interface to Compress-Raw-Zlib now uses the new LimitOutput
37 feature. This will make all of the zlib-related IO-Compress modules
38 less greedy in their memory consumption.
40 * Removed MAN3PODS from Makefile.PL
42 * A few changes to get the test harness to work on VMS courtesy of
45 * IO::Compress::Base & IO::Uncompress::Base
46 Downgraded some croaks in the constructors to just set $! (by letting
47 the code attempt to open a file and fail).
48 This makes the behavior more consistent to a standard open.
51 * IO::Uncompress::Base
52 Doing a seek with MultiStream could drop some of the uncompressed
56 - Fixed problem with the uncompressed & uncompressed fields when
57 zip64 is enabled. They were set to 0x0000FFFF instead of
58 0xFFFFFFFF. Also the ZIP64 extra field was 4 bytes short.
59 Problem spotted by Dino Chiesa.
61 * IO::Uncompress::Unzip
62 - use POSIX::mktime instead of Time::Local::timelocal to convert
63 the zip DOS time field into Unix time.
66 - Documented Compress::Zlib::zlib_version()
69 2.015 3 September 2008
72 Backout changes made in 2.014
74 2.014 2 September 2008
77 Updated to check for indirect dependencies.
82 - Allow IO::Compress::Base::Parameters::parse to accept an
83 IO::Compress::Base::Parameters object.
88 - Silenced an uninitialised value warning when reading a line
89 at a time from a zip file where the content uses ZIP_CM_STORE.
90 [Problem spotted & fixed by Jeff Holt]
92 * IO::Compress::Base & IO::Uncompress::Base
93 - local-ise $!, $? et al in the DESTROY methods.
98 - Fixed problem that prevented the creation of a zip file that
99 contained more than one compression method.
101 * IO::Compress::Base::Common
102 - The private Validator class in this module clashes with another
103 CPAN module. Moved Validator into the IO::Compress::Base::Common
107 * IO::Uncompress::Unzip
108 - Print an error message if the zip file contains a
109 member compressed with bzip2 and IO::Uncompress::Bunzip2 is
111 - Could not cope with mixed compression zip files. For example a
112 zip file that contains both STORED and DEFLATED content.
117 * Fixed problem that meant Perl 5.10 could not upgrade this module.
122 * Removed the alpha status from File::GlobMapper
125 When writing output never output a zero length buffer.
126 Done to improve interoperability with other tied filenandle
129 * Changed IO::Uncompress::Base to not use the offset parameter of
130 the read method when reading from a filehandle.
132 The object returned from Net::FTP::retr implements a non-standard
133 read method. The third parameter is used for a timeout value
134 rather than an offset.
137 * Changed IO::Uncompress::Base to not use the eof method when
138 reading from a filehandle.
140 The object returned from Net::FTP::retr implements both the read
141 method and the eof method. Unfortunately the implementation of
142 the read method uses non-buffered IO (by using sysread) while
143 the eof method uses buffered IO. Mixing buffered and non-buffered
144 IO results in data corruption.
148 - Added exUnix2 option to allow storing of UID & GID.
149 - When running on a Unix derivative the ExtAttr option now defaults
150 to the equivalent of 0666. For all other systems the default
154 - Minor documentation issue with flush.
158 2.008 2 November 2007
160 * Minor documentation changes in README
162 * t/compress/truncate.pl
165 * IO::Compress::Gzip::Constants.pm
166 Tidied up the character classes used to defined invalid
167 FNAME & FCOMMENT fields for EBCDIC.
170 lib/Compress/Zlib.pm -- 1.x Backward Compatability issues
171 gzclose - documented return value was wrong, should be 0 for ok.
172 gzflush - return value didn't match 1.x, should return 0 if ok.
173 [rt.cpan.org #29215] and Debian bug #440943 http://bugs.debian.org/440943
175 2.006 1 September 20007
178 Added INSTALLDIRS directive to install as a core module when built
181 * IO::Uncompress::RawDeflate
183 - Fixed export problem - "$RawDeflateError" and "rawdeflate" were
184 not being exported with ":all".
188 Fixed crc32 and adler32 tests in to remove ascii assumption.
190 - lib/Compress/Zlib.pm
191 Make gzreadline not support $/, just like in Compress::Zlib 1.x
192 Folk who want $/ with readline support can get it in
193 IO::Uncompress::Gunzip. [rt.cpan.org #28663] and
194 Debian bug #435656 http://bugs.debian.org/435656
199 * Stephen Turner reported a problem when using IO::Uncompress::Gunzip
200 with XML::Parser. Turns out there were two issues.
202 Firstly an IO::Uncompress object isn't an IO::Handle. It is now.
204 Secondly the implementation of "read" wasn't honouring this
206 SCALAR will be grown or shrunk to the length actually read.
208 In particular it didn't do the right thing on EOF.
211 * IO::Compress::Gzip & IO::Uncompress::Gunzip
213 - RFC1952 says that the FNAME & FCOMMENT header fields must be ISO
214 8859-1 (LATIN-1) characters. The code can optionally police this.
215 Added a fix for this logic when running on EBCDIC.
218 Added info about removing Compress::Zlib version 1, before
219 installing version 2.
223 * Made seek less wasteful of memory.
227 - Added Zip64 documentation.
229 - Fixed extended timestamp.
230 Creation time isn't available in Unix so only store the
231 modification time and the last access time in the extended field.
235 - Added ExtAttr option to control the value of the "external file
236 attributes" field in the central directory.
238 - Added Unix2 extended attribute ("Ux").
239 This stores the UID & GID.
243 - Fixed 050interop-gzip.t for Windows
245 * IO::Compress::Bzip2
247 - Fixed 050interop-bzip2.t for Windows
251 - rewrote memGzip using IO::Compress::Gzip::gzip
255 * Added explicit version checking
257 2.002 29 December 2006
259 * Documentation updates.
261 * Added IO::Handle to the ISA test in isaFilehandle
263 * Add an explicit use_ok test for Scalar::Util in the test harness.
264 The error message reported by 01misc implied the problem was
266 Also explictly check that 'dualvar' is available.
269 - Fix append mode with gzopen.
272 - Allow gzopen to read from and write to a scalar reference.
274 2.001 1 November 2006
276 * Remove beta status.
278 2.000_14 26 October 2006
280 * IO::Uncompress::Base
281 Added support for $/ in record mode
283 * IO::Uncompress::Base
284 The readline interface was substantially slower than the 1.x
285 equivalent. This has now been sorted.
286 Thanks to Andreas J. Koenig for spotting the problem.
288 * IO::Uncompress::AnyUncompress
289 Added IO::Uncompress::Lzf to the list of supported uncompresors.
291 * IO::Uncompress::Base
292 Added TrailingData to one-shot interface.
294 * IO::Uncompress::AnyUncompress
295 Remove raw-deflate (RFC1951) from the default list of compressors
297 It can still be included if the new RawInflate parameter is
299 This change was made because the only way to tell if content is
300 raw-deflate is to attempt to uncompress it - a few false positives
301 have popped up recently, which suggests that auto-detecting raw
302 deflate is far from perfect.
303 The equivalent change has been made to IO::Uncompress::AnyInflate.
306 * Don't check that filehandles are writable. It would seem that
307 "-w *STDOUT" on windows returns false.
310 * IO::Uncompress::Deflate
311 Beefed up the magic signature check. Means less false positives
312 when auto-detecting the compression type.
314 * IO::Uncompress::UnZip
315 Tighten up the zip64 extra field processing to cope with the case
316 wheere only some of the local header fields are superceeded.
318 * IO::Uncompress::AnyInflate
319 Remove raw-deflate (RFC 1951) from the default list of compressors
321 It can still be included if the new RawInflate parameter is
323 This change was made because the only way to tell if content is
324 raw-deflate is to attempt to uncompress it - a few false positives
325 have popped up recently, which suggests that auto-detecting raw
326 deflate is far from perfect.
327 The equivalent change has been made to IO::Uncompress::AnyUncompress.
330 2.000_13 20 June 2006
332 * Store compress & uncompressed sizes as 64-bit.
334 * For one-shot uncompression, like this
336 unzip "some.zip" => \@a, MultiStream => 1;
338 Push each uncompressed stream from "some.zip" onto @a.
340 * Added IO::Compress::Base::FilterEnvelope
342 * Added IO::Uncompress::Base::nextStream
344 * The '-' filehandle now maps to either *STDIN or *STDOUT.
345 This keeps mod_perl happier. Was using these before
350 * Preliminary support for reading zip files with zip64 members.
354 * Moved the code for creating and parsing the gzip extra field into
355 IO::Compress::Zlib::Extra.pm so that IO::Compress::Zip &
356 IO::Uncompress::Unzip can use it as well.
358 * Added ExtraFieldLocal & ExtraFieldCentral options to IO::Compress::Zip.
359 These allow the creation of user-defined extra fields in the local
360 and central headers, just like the ExtraField option in
363 * Moved the zip constants into IO::Compress::Zip::Constants
365 * Added exTime option to IO::Compress::Zip.
366 This allows creation of the extended timestamp extra field.
368 * Added Minimal option to IO::Compress::Zip.
369 This disables the creation of all extended fields.
371 * Added TextFlag option to IO::Compress::Zip.
373 * Documented Comment and ZipComment options in IO::Compress::Zip.
376 Fixed gzread to zap the output buffer to an empty string when zero
377 bytes are requested. This matches the behaviour of C::Z 1.x
379 2.000_11 10 April 2006
381 * Transparent + InputLength made more robust where input data is not
384 * Updated Documentation for zip modules.
386 * Changed IO::Compress::Zip 'Store' option to 'Method' and added
387 symbolic constants ZIP_CM_STORE, ZIP_CM_DEFLATE and ZIP_CM_BZIP2 to
388 allow the compression method to be picked by the user.
390 * Added support to allow bzip2 compressed data to be written/read
391 with IO::Compress::Zip and IO::Uncompress::Unzip.
393 * Beefed up 050interop-gzip.t to check that the external gzip command
394 works as expected before starting the tests. This means that
395 this test harness will just be skipped on problematic systems.
397 * Merged core patch 27565 from Steve Peters. This works around a
398 problem with gzip on OpenBSD where it doesn't seem to like
399 compressing files < 10 bytes long.
401 * Beefed up 050interop-bzip2.t to check that the external bzip2 command
402 works as expected before starting the tests. This means that
403 this test harness will just be skipped on problematic systems.
405 2.000_10 13 March 2006
407 * AnyUncompress doesn't assume that IO-Compress-Zlib is installed any
410 * Documentation updates.
413 Changed gzread so that its behaviour matches C::Z::gzread 1.x if it
414 is called after eof. In this case it will write an empty string
415 into the output parameter. This change is solely for backward
416 compatability reasons.
418 2.000_09 3 March 2006
422 2.000_08 2 March 2006
424 * Split IO::Compress::Base into its own distribution.
426 * Split IO::Compress::Bzip2 into its own distribution.
428 * Added opened, autoflush and input_line_number.
430 * Beefed up support for $.
432 * Split IO::Compress::Zlib into its own distribution.
434 * Beefed up support for zip/unzip
436 * Breakout zlib specific code into separate modules.
438 * Limited support for reading/writing zip files
440 2.000_06 5 October 2005
442 * Added eof parameter to Compress::Zlib::inflate method.
444 * Fixed issue with 64-bit
446 2.000_05 4 October 2005
448 * Renamed IO::* to IO::Compress::* & IO::Uncompress::*
450 2.000_04 23 September 2005
452 * Fixed some more non-portable test that were failing on VMS.
454 * fixed problem where error messages in the oneshot interface were
457 2.000_03 12 September 2005
459 * Fixed some non-portable test that were failing on VMS.
461 * Fixed export of zlib constants from the IO::* classes
463 2.000_02 6 September 2005
465 * Split Append mode into Append and Merge
467 * Fixed typos in the documentation.
471 * Added libscan to Makefile.PL
473 * Added InputLength for IO::Gunzip et al
475 2.000_01 22 August 2005
477 * Fixed VERSION in Compress::Gzip::Constants
479 * Removed Compress::Gzip::Info from the distribution.
481 2.000_00 21 August 2005
483 * First Beta relase of Compress::zlib rewrite.
485 Compress-Zlib version 1 Changes
487 1.38 - 6 September 2005
489 * Integrate core change 25304 -- Symbian Update
491 * Added libscan to Makefile.PL
493 1.37 - 12 August 2005
495 * Change to t/03examples.t for VMS from Abe Timmerman
499 * Renamed zlib-src-1.2.3 to zlib-src to help VMS
501 * Fixed Makefile.PL for VMS
503 * Fixed t/03examples.t for VMS
505 * Added a couple of notes about incompatibility with Unix compress.
509 * Updated zlib source to 1.2.3
511 * Fixed problem with where two calls to gzclose would hang the debugger.
512 See https://rt.cpan.org/Ticket/Display.html?id=13789
514 * Added code from Alexey Tourbin to use XSLoader when available,
515 and DynaLoader otherwise.
517 * Documented that the compress & uncompress functions were not
518 the same as the Unix utilities of the same name.
520 * Fixed 05gzsetp -- it left a temp file hanging around.
522 * Integrate core change 24787 - SvUPGRADE returns void in blead
524 * Integrate core change 24788 - Makefile.PL adjustments for the core
527 1.34 - 30 January 2005
529 * Fixed typo in the README
531 * Fixed examples.t on Win32 where paths have embedded whitespace.
533 * Fix for Cygwin and core integration from Jos I. Boumans
535 * Upgrade zlib source to 1.2.2
537 1.33 - 14 January 2004
539 * Reworked Makefile.PL to avoid creating a private copy of zlib.
540 This both simplifies the build, plus it makes life easier for VMS.
542 * Patches for Makefile.PL to get it to work on VMS supplied by
545 * memGunzip has very slow on FreeBSD. Turns out to be down to
546 the way realloc works on FreeBSD. Changed both inflate & deflate
547 to use exponentially increasing buffer sizes when they need to
548 realloc. Thanks to Peter Jeremy for the lowdown on FreeBSD
551 1.32 - 26 November 2003
553 * Steve Hay reported a problem on rt.cpan.org with Windows and
554 MSCV++ 6.0 where the source from the zlib directory was getting
555 installed with the rest of the module.
556 https://rt.cpan.org/Ticket/Display.html?id=1741
558 This has been fixed by renaming the "zlib" directory to "zlib-src"
559 thus avoiding a conflict with the name of this Perl module.
561 * Fixed a bug in the inflate method where the input buffer is an
562 lvalue (via substr). Problem & solution reported by Salvador Fandiqo.
564 * Tightened up the logic in Makefile.PL when BUILD_ZLIB is
565 True. Issue spotted by Ralf S. Engelschall.
567 1.31 - 29 October 2003
569 * Reinstated the creation of .bak files - $^I seems to need a
570 backup file on Windows. For OpenVMS, the extenstion _bak is used.
572 1.30 - 28 October 2003
574 * Bundled a sub-set of the zlib source with the module and changed
575 the default make behaviour to build with the included zlib source.
576 The previous behaviour of using a pre-built zlib library is
577 still available for those that want it.
579 * Added prototypes to the subs in Zlib.pm that didn't already have
580 them. Patch from Ed Avis.
582 * No .bak files are created by Makefile.PL any more - this keep
583 distclean much happier. Patch suggested by Ed Avis.
584 This also fixes a similar problem reported by Dr. Martin Zinser
587 * Documentation for some of the gz functions updated.
589 * Format strings modified in DispStream to keep OpenVMS happy.
590 Problem reported by Dr. Martin Zinser.
595 * Makefile.PL now displays a warning about not installing
596 Compress::Zlib via the CPAN shell.
598 * Fix to allow intermingling of gzread & gzreadline - patch
599 supplied by Doug Perham.
601 * memGunzip will silently now work if the gzip trailer is
602 missing. Some HTTP Origin Servers seem to leave it out.
606 * Tests 148 & 150 from t/02zlib.t were failing on redhat 9.
608 * Added a few words about the problems with Mac OS X to the README file.
612 * Fixed bug in gzopen where $gzerrno wasn't being set correctly.
613 The symptom was $gzerrno was set to Z_MEM_ERROR although the file
614 was opened ok. If gzopen failed, $gzerrno was being set correctly.
615 This problem wasn't spotted before because the typical test
616 to determine whether gzopen passed or failed was to check its
619 1.19 - 31 October 2002
621 * fixed a problem with t/02zlib.t that was failing with redhat 8.
623 1.18 - 24 October 2002
625 * fixed a Win32 problem in t/02zlib.t by changing sysread to read.
627 * zlib 1.0.5 & older doesn't have gzsetparams & gzeof. Added a new
628 variable to config.in to flag an old version of zlib. Split
629 out the tests for gzsetparams into t/05gzsetp.t
633 * Moved the test to check the versions of libz & zlib.h into a separate
634 file and added troubleshooting notes to README.
636 * In gzopen, only attempt to call "tell" for normal files.
638 * Fixed to work in taint mode.
640 * Broke changes out of README into Changes file.
642 * Replaced internal use of Z_PARTIAL_FLUSH symbol with Z_SYNC_FLUSH.
643 zlib.h says /* will be removed, use Z_SYNC_FLUSH instead */
645 1.16 - 13 December 2001
647 * Fixed bug in Makefile.PL that stopped "perl Makefile.PL PREFIX=..."
650 1.15 - 4th December 2001
652 * Changes a few types to get the module to build on 64-bit Solaris
654 * Changed the up/downgrade logic to default to the older constructs, and
655 to only call a downgrade if specifically requested. Some older versions
656 of Perl were having problems with the in-place edit.
658 * added the new XS constant code.
660 1.14 - 27th August 2001
662 * Memory overwrite bug fixed in "inflate". Kudos to Rob Simons for
663 reporting the bug and to Anton Berezin for fixing it for me.
665 1.13 - 31st June 2001
667 * Make sure config.in is consistant when released.
669 1.12 - 28th April 2001
671 * Modified Makefile.PL to only enable the warnings pragma if
672 using perl 5.6.1 or better.
674 1.11 - 17th February 2001
676 * Added logic in Makefile.PL to toggle between using $^W and
677 the warnings pragma in the module.
679 * The module, the examples & the test harness are now all strict
682 1.10 - 5th February 2001
684 * fixed a bug in memGunzip. Used Z_ERR instead of Z_DATA_ERROR.
686 1.09 - 15th January 2001
688 * Silenced a few compiler warnings.
690 * Updated zlib home site in README & Zlib.pm to www.info-zip.org
692 * Minor typo in Zlib.pm - a link used AUTHORS instead of AUTHOR
693 -- spotted by Frank Martini.
695 * Mention Archive::Zip
697 * added memGunzip. This is largely based on code provided by Jim Leonard.
699 * $deflate->flush can now take an optional parameter. Valid
700 values are Z_NO_FLUSH, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, Z_FULL_FLUSH
701 and Z_FINISH. The default is Z_FINISH.
705 * uncompress was clobbering its input parameter. Now it doesn't.
706 This bug was spotted by Deven T. Corzine.
708 * If a variable that only ever contained a number was given
709 to compress or deflate, it would not be compressed properly. Now
710 it will be coerced to a string and then compressed. This bug
711 was spotted by Deven T. Corzine.
715 * ANSI-ified the static functions in Zlib.xs
717 * Added the ability to build zlib along with the module.
718 This feature is 90% based on a Makefile provided by Gurusamy
723 * Fixed a nasty problem where inflate could truncate the data
724 returned. Thanks to Douglas Thomson <dougt@mugc.cc.monash.edu.au>
725 for both spotting the problem and fixing the bug.
727 * Added a note about the undocumented features in zlib that are
728 required when accessing zip files.
730 * gzclose will now get called automatically when the gzip object is
735 * Previous release used newSVpvn, which doesn't exist in 5.004_04
736 or earlier. Changed to use newSVpv instead.
738 * The module needs Perl 5.004 or better, so updated the version
739 checking in Zlib.pm and Makefile.PL
743 * Bug 19990527.001: compress(undef) core dumps -- Fixed.
747 * Updated to use the new PL_ symbols.
748 Means the module can be built with Perl 5.005_5*
752 * The return codes for gzread, gzreadline and gzwrite were
753 documented incorrectly as returning a status code.
755 * The test harness was missing a "gzclose". This caused problem
756 showed up on an amiga. Thanks to Erik van Roode for reporting
759 * Patched zlib.t for OS/2. Thanks to Ilya Zakharevich for the patch.
763 * A number of fixes to the test suite and the example scripts to
764 allow them to work under win32. All courtesy of Gurusamy
769 * Fixed crc32 & adler32. They were very broken.
771 * The following functions can now take a scalar reference in
772 place of a scalar for their buffer parameters:
781 This should mean applications that make use of the module don't
782 have to copy large buffers around.
785 * Normally the inflate method consumes I<all> of the input buffer
786 before returning. The exception to this is when inflate detects
787 the end of the stream (Z_STREAM_END). In this case the input
788 buffer need not be completely consumed. To allow processing of
789 file formats that embed a deflation stream (e.g. zip, gzip),
790 the inflate method now sets the buffer parameter to be what
791 remains after inflation.
793 When the return status is Z_STREAM_END, it will be what remains
794 of the buffer (if any) after deflation. When the status is Z_OK
795 it will be an empty string.
797 This change means that the buffer parameter must be a lvalue.
799 * Fixed crc32 and adler32. They were both very broken.
801 * Added the Compress::Zlib::memGzip function.
803 0.5 - Confirmed that no changes were necessary for zlib 1.0.3, or 1.0.4.
805 The optional parameters for deflateInit and inflateInit can now
806 be specified as an associative array in addition to a reference
807 to an associative array. They can also accept the -Name
810 gzopen can now optionally take a reference to an open
811 filehandle in place of a filename. In this case it will call
814 Added gzstream example script.
816 0.4 - Upgrade to support zlib 0.99
818 Added dictionary interface.
820 Fixed bug in gzreadline - previously it would keep returning
821 the same buffer. This bug was reported by Helmut Jarausch
823 Removed dependency to zutil.h and so dropped support for
825 DEF_MEM_LEVEL (use MAX_MEM_LEVEL instead)
826 DEF_WBITS (use MAX_WBITS instead)
828 0.3 - Added prototype specification.
830 0.2 - Fixed a minor allocation problem in Zlib.xs
832 0.1 - first alpha release. 2nd October 1995