Stefan Bodewig | bdd4bd6 | 2015-01-30 08:14:03 +0000 | [diff] [blame] | 1 | Apache Commons Compress RELEASE NOTES |
Sebastian Bazley | 48882f1 | 2010-04-13 21:02:37 +0000 | [diff] [blame] | 2 | |
Stefan Bodewig | 4a15417 | 2013-10-13 04:06:16 +0000 | [diff] [blame] | 3 | Apache Commons Compress software defines an API for working with |
| 4 | compression and archive formats. These include: bzip2, gzip, pack200, |
Stefan Bodewig | de63306 | 2014-10-09 12:00:48 +0000 | [diff] [blame] | 5 | lzma, xz, Snappy, traditional Unix Compress, DEFLATE and ar, cpio, |
| 6 | jar, tar, zip, dump, 7z, arj. |
| 7 | |
Stefan Bodewig | b9acd7c | 2016-12-25 13:02:22 +0100 | [diff] [blame] | 8 | Release 1.13 |
| 9 | ------------ |
| 10 | |
Stefan Bodewig | 4543847 | 2016-12-25 13:16:42 +0100 | [diff] [blame^] | 11 | Commons Compress 1.13 is the first version to require Java 7 at |
Stefan Bodewig | b9acd7c | 2016-12-25 13:02:22 +0100 | [diff] [blame] | 12 | runtime. |
| 13 | |
| 14 | Changes in this version include: |
| 15 | |
| 16 | New features: |
| 17 | o SevenZFile, SevenZOutputFile, ZipFile and |
| 18 | ZipArchiveOutputStream can now work on non-file resources if |
| 19 | they can be accessed via SeekableByteChannel. |
| 20 | Issue: COMPRESS-327. |
| 21 | o Allow compressor extensions through a standard JRE ServiceLoader. |
| 22 | Issue: COMPRESS-368. |
| 23 | o Allow archive extensions through a standard JRE ServiceLoader. |
| 24 | Issue: COMPRESS-369. |
| 25 | o Add write support for the legacy LZMA format, this requires XZ |
| 26 | for Java 1.6. |
| 27 | Issue: COMPRESS-373. |
| 28 | o Add write support for the legacy LZMA stream to 7z, this |
| 29 | requires XZ for Java 1.6. |
| 30 | Issue: COMPRESS-374. |
| 31 | o Allow the clients of ParallelScatterZipCreator to provide |
| 32 | ZipArchiveEntryRequestSupplier. |
| 33 | Issue: COMPRESS-375. Thanks to Plamen Totev. |
| 34 | o Add a version-independent link to the API docs of the latest |
| 35 | release. |
| 36 | Issue: COMPRESS-372. |
| 37 | |
| 38 | Fixed Bugs: |
| 39 | o BitInputStream could return bad results when overflowing |
| 40 | internally - if two consecutive reads tried to read more than |
| 41 | 64 bits. |
| 42 | Issue: COMPRESS-363. |
| 43 | o ZipArchiveInputStream.closeEntry does not properly advance to |
| 44 | next entry if there are junk bytes at end of data section. |
| 45 | Issue: COMPRESS-364. Thanks to Mike Mole. |
| 46 | o ZipArchiveInputStream now throws an Exception if it encounters |
| 47 | a broken ZIP archive rather than signaling end-of-archive. |
| 48 | Issue: COMPRESS-367. Thanks to Mike Mole. |
| 49 | o ScatterZipOutputStream didn't close the StreamCompressor |
| 50 | causing a potential resource leak. |
| 51 | Issue: COMPRESS-377. |
| 52 | |
| 53 | Changes: |
| 54 | o Update Java requirement from 6 to 7. |
| 55 | Issue: COMPRESS-360. |
| 56 | o Clarified which TarArchiveEntry methods are useless for |
| 57 | entries read from an archive. |
| 58 | Issue: COMPRESS-366. |
| 59 | |
Stefan Bodewig | 3623ee7 | 2016-06-18 17:25:37 +0200 | [diff] [blame] | 60 | Release 1.12 |
Stefan Bodewig | 4c11f12 | 2016-06-18 17:17:37 +0200 | [diff] [blame] | 61 | ------------ |
| 62 | |
Stefan Bodewig | 9a677fb | 2016-06-21 21:27:57 +0200 | [diff] [blame] | 63 | Commons Compress 1.12 is the first version to require Java 6 at |
Stefan Bodewig | 4c11f12 | 2016-06-18 17:17:37 +0200 | [diff] [blame] | 64 | runtime. |
| 65 | |
| 66 | Release 1.12 changes the behavior of BZip2CompressorOutputStream's |
| 67 | finalize method so that it no longer invokes finish. This is going to |
| 68 | break code that relied on the finalizer to clean up an unfinished |
| 69 | stream. The code will need to be changed to call finish or close |
| 70 | itself. Note that a finalizer is not guaranteed to run, so the feature |
| 71 | was not 100% effective in any case. |
| 72 | |
| 73 | New features: |
| 74 | |
| 75 | o FramedSnappyCompressorInputStream now supports the dialect of |
| 76 | Snappy used by the IWA files contained within the zip archives |
| 77 | used in Apple's iWork 13 files. |
| 78 | Issue: COMPRESS-352. |
| 79 | |
| 80 | Fixed Bugs: |
| 81 | |
| 82 | o SevenZFile.read() throws an IllegalStateException for empty entries. |
| 83 | Issue: COMPRESS-348. |
| 84 | o TarArchiveInputStream failed to parse PAX headers that included |
| 85 | blank lines. |
| 86 | Issue: COMPRESS-355. Thanks to Jeremy Gustie. |
| 87 | o TarArchiveInputStream failed to parse PAX headers whose tar entry |
| 88 | name ended with a slash. |
| 89 | Issue: COMPRESS-356. Thanks to Jeremy Gustie. |
| 90 | |
| 91 | Changes: |
| 92 | o Update requirement from Java 5 to 6. |
| 93 | Issue: COMPRESS-349. |
| 94 | o TarArchiveEntry wastefully allocates empty arrays. |
| 95 | Issue: COMPRESS-350. |
| 96 | o Javadoc for BZip2CompressorInputStream(InputStream, boolean) should |
| 97 | refer to IOEx, not NPE. |
| 98 | Issue: COMPRESS-353. |
| 99 | o PureJavaCrc32C in the snappy package is now final so it is now safe |
| 100 | to call a virtual method inside the constructor. |
| 101 | Issue: COMPRESS-354. |
| 102 | |
| 103 | o ZipArchiveInputStream and CpioArchiveInputStream could throw |
| 104 | exceptions who's messages contained potentially corrupt entry names |
| 105 | read from a broken archive. They will now sanitize the names by |
| 106 | replacing unprintable characters and restricting the length to 255 |
| 107 | characters. |
| 108 | Issue: COMPRESS-351. |
| 109 | o BZip2CompressorOutputStream no longer tries to finish the output |
| 110 | stream in finalize. This is a breaking change for code that relied |
| 111 | on the finalizer. |
| 112 | Issue: COMPRESS-357. |
| 113 | |
| 114 | |
Stefan Bodewig | ff38bf5 | 2016-03-30 15:12:33 +0200 | [diff] [blame] | 115 | Release 1.11 |
Torsten Curdt | 68db5fa | 2016-01-15 15:35:17 +0100 | [diff] [blame] | 116 | ------------ |
| 117 | |
Stefan Bodewig | ff38bf5 | 2016-03-30 15:12:33 +0200 | [diff] [blame] | 118 | New features: |
| 119 | o TarArchiveInputStream now supports reading global PAX headers. |
| 120 | Issue: COMPRESS-347. |
| 121 | o The PAX headers for sparse entries written by star are now |
| 122 | applied. |
| 123 | Issue: COMPRESS-346. |
| 124 | o GNU sparse files using one of the PAX formats are now |
| 125 | detected, but cannot be extracted. |
| 126 | Issue: COMPRESS-345. |
| 127 | o New method SevenZFile.getEntries can be used to list the |
| 128 | contents of a 7z archive. |
| 129 | Issue: COMPRESS-341. |
| 130 | o When using Zip64Mode.Always also use ZIP64 extensions inside |
| 131 | the central directory. |
| 132 | GitHub Pull Request #10 Thanks to Matt Hovey. |
| 133 | o ZipFile.getRawInputStream() is now part of the public API |
| 134 | Issue: COMPRESS-323. |
| 135 | o Allow byte-for-byte replication of Zip entries. |
| 136 | GitHub Pull Request #6. Thanks to Jason van Zyl. |
Torsten Curdt | 68db5fa | 2016-01-15 15:35:17 +0100 | [diff] [blame] | 137 | o TarArchiveEntry's preserveLeadingSlashes is now a property and used |
| 138 | on later calls to setName, too. |
| 139 | This behavior is a breaking change. |
Stefan Bodewig | ff38bf5 | 2016-03-30 15:12:33 +0200 | [diff] [blame] | 140 | Issue: COMPRESS-328. |
| 141 | o Added read-only support for bzip2 compression used inside of |
| 142 | ZIP archives. |
| 143 | GitHub Pull Request #4. Thanks to Sören Glimm. |
| 144 | |
| 145 | Fixed Bugs: |
| 146 | o ArArchiveInputStream can now read GNU extended names that are |
| 147 | terminated with a NUL byte rather than a linefeed. |
| 148 | Issue: COMPRESS-344. |
| 149 | o Native Memory Leak in Sevenz-DeflateDecoder. |
| 150 | Issue: COMPRESS-343. Thanks to Rene Preissel. |
| 151 | o SevenZFile will now only try to drain an entry's content when |
| 152 | moving on to the next entry if data is read from the next |
| 153 | entry. This should improve performance for applications that |
| 154 | try to skip over entries. |
| 155 | Issue: COMPRESS-340. Thanks to Dawid Weiss. |
| 156 | o file names of tar archives using the xstar format are now |
| 157 | parsed properly. |
| 158 | Issue: COMPRESS-336. |
| 159 | o checksums of tars that pad the checksum field to the left are |
| 160 | now calculated properly. |
| 161 | Issue: COMPRESS-335. |
| 162 | o ArArchiveInputStream failed to read past the first entry when |
| 163 | BSD long names have been used. |
| 164 | Issue: COMPRESS-334. Thanks to Jeremy Gustie. |
| 165 | o Added buffering for random access which speeds up 7Z support. |
| 166 | Issue: COMPRESS-333. Thanks to Dawid Weiss. |
| 167 | o The checksum validation of TararchiveEntry is now as strict as |
| 168 | the validation of GNU tar, which eliminates a few cases of |
| 169 | false positives of ArchiveStreamFactory. |
| 170 | This behavior is a breaking change since the check has become |
| 171 | more strict but any archive that fails the checksum test now |
| 172 | would also fail it when extracted with other tools and must be |
| 173 | considered an invalid archive. |
| 174 | Issue: COMPRESS-331. |
| 175 | o SnappyCompressorInputStream and |
| 176 | FramedSnappyCompressorInputStream returned 0 at the end of the |
| 177 | stream under certain circumstances. |
| 178 | Issue: COMPRESS-332. |
| 179 | o Adjusted unit test to updates in Java8 and later that change |
| 180 | the logic of ZipEntry#getTime. |
| 181 | Issue: COMPRESS-326. |
| 182 | o TarArchiveOutputStream will now recognize GNU long name and |
| 183 | link entries even if the special entry has a different name |
| 184 | than GNU tar uses itself. This seems to be the case for |
| 185 | archives created by star. |
| 186 | Issue: COMPRESS-324. |
| 187 | o ArrayIndexOutOfBoundsException when InfoZIP type 7875 extra |
| 188 | fields are read from the central directory. |
| 189 | Issue: COMPRESS-321. |
Torsten Curdt | 68db5fa | 2016-01-15 15:35:17 +0100 | [diff] [blame] | 190 | |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 191 | Release 1.10 |
| 192 | ------------ |
| 193 | |
| 194 | Release 1.10 moves the former |
| 195 | org.apache.commons.compress.compressors.z._internal_ package which |
| 196 | breaks backwards compatibility for code which used the old package. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 197 | |
| 198 | This also changes the superclass of ZCompressorInputStream which makes |
| 199 | this class binary incompatible with the one of Compress 1.9. Code |
| 200 | that extends ZCompressorInputStream will need to be recompiled in |
| 201 | order to work with Compress 1.10. |
Stefan Bodewig | c100d2e | 2015-01-30 08:24:54 +0000 | [diff] [blame] | 202 | |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 203 | New features: |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 204 | o CompressorStreamFactory can now auto-detect DEFLATE streams |
| 205 | with ZLIB header. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 206 | Issue: COMPRESS-316. Thanks to Nick Burch. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 207 | o CompressorStreamFactory can now auto-detect LZMA streams. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 208 | Issue: COMPRESS-313. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 209 | o Added support for parallel compression. This low-level API allows |
| 210 | a client to build a zip/jar file by using the class |
| 211 | org.apache.commons.compress.archivers.zip.ParallelScatterZipCreator. |
| 212 | |
| 213 | Zip documentation updated with further notes about parallel features. |
| 214 | |
| 215 | Please note that some aspects of jar creation need to be |
| 216 | handled by client code and is not part of commons-compress for this |
| 217 | release. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 218 | Issue: COMPRESS-296. Thanks to Kristian Rosenvold. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 219 | o Cut overall object instantiation in half by changing file |
| 220 | header generation algorithm, for a 10-15 percent performance |
| 221 | improvement. |
| 222 | |
| 223 | Also extracted two private methods createLocalFileHeader |
| 224 | and createCentralFileHeader in ZipArchiveOutputStream. |
| 225 | These may have some interesting additional usages in the |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 226 | near future. Thanks to Kristian Rosenvold. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 227 | o New methods in ZipArchiveOutputStream and ZipFile allows |
| 228 | entries to be copied from one archive to another without |
| 229 | having to re-compress them. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 230 | Issue: COMPRESS-295. Thanks to Kristian Rosenvold. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 231 | |
| 232 | Fixed Bugs: |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 233 | o TarArchiveInputStream can now read entries with group or |
| 234 | user ids > 0x80000000. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 235 | Issue: COMPRESS-314. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 236 | o TarArchiveOutputStream can now write entries with group or |
| 237 | user ids > 0x80000000. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 238 | Issue: COMPRESS-315. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 239 | o TarArchiveEntry's constructor with a File and a String arg |
| 240 | didn't normalize the name. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 241 | Issue: COMPRESS-312. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 242 | o ZipEncodingHelper no longer reads system properties directly |
| 243 | to determine the default charset. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 244 | Issue: COMPRESS-308. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 245 | o BZip2CompressorInputStream#read would return -1 when asked to |
| 246 | read 0 bytes. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 247 | Issue: COMPRESS-309. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 248 | o ArchiveStreamFactory fails to pass on the encoding when creating |
| 249 | some streams. |
| 250 | * ArjArchiveInputStream |
| 251 | * CpioArchiveInputStream |
| 252 | * DumpArchiveInputStream |
| 253 | * JarArchiveInputStream |
| 254 | * TarArchiveInputStream |
| 255 | * JarArchiveOutputStream |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 256 | Issue: COMPRESS-306. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 257 | o Restore immutability/thread-safety to ArchiveStreamFactory. |
| 258 | The class is now immutable provided that the method setEntryEncoding |
| 259 | is not used. The class is thread-safe. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 260 | Issue: COMPRESS-302. |
Stefan Bodewig | b1e2a02 | 2015-08-18 17:49:15 +0000 | [diff] [blame] | 261 | o Restore immutability/thread-safety to CompressorStreamFactory. |
| 262 | The class is now immutable provided that the method |
| 263 | setDecompressConcatenated is not used. The class is thread-safe. |
| 264 | Issue: COMPRESS-303. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 265 | o ZipFile logs a warning in its finalizer when its constructor |
| 266 | has thrown an exception reading the file - for example if the |
| 267 | file doesn't exist. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 268 | Issue: COMPRESS-297. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 269 | o Improved error message when tar encounters a groupId that is |
| 270 | too big to write without using the STAR or POSIX format. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 271 | Issue: COMPRESS-290. Thanks to Kristian Rosenvold. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 272 | o SevenZFile now throws the specific PasswordRequiredException |
| 273 | when it encounters an encrypted stream but no password has |
| 274 | been specified. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 275 | Issue: COMPRESS-298. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 276 | |
| 277 | Changes: |
| 278 | o Moved the package |
| 279 | org.apache.commons.compress.compressors.z._internal_ to |
| 280 | org.apache.commons.compress.compressors.lzw and made it part |
| 281 | of the API that is officially supported. This will break |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 282 | existing code that uses the old package. Thanks to Damjan Jovanovic. |
Stefan Bodewig | ec07514 | 2015-01-26 05:12:09 +0000 | [diff] [blame] | 283 | |
| 284 | For complete information on Apache Commons Compress, including instructions |
| 285 | on how to submit bug reports, patches, or suggestions for improvement, |
| 286 | see the Apache Commons Compress website: |
| 287 | |
| 288 | http://commons.apache.org/compress/ |
| 289 | |
| 290 | Old Release Notes |
| 291 | ================= |
| 292 | |
Stefan Bodewig | de63306 | 2014-10-09 12:00:48 +0000 | [diff] [blame] | 293 | Release 1.9 |
| 294 | ----------- |
| 295 | |
| 296 | New features: |
| 297 | o Added support for DEFLATE streams without any gzip framing. |
| 298 | Issue: COMPRESS-263. |
| 299 | Thanks to Matthias Stevens. |
| 300 | |
| 301 | Fixed Bugs: |
| 302 | o When reading 7z files unknown file properties and properties of type |
| 303 | kDummy are now ignored. |
| 304 | Issue: COMPRESS-287. |
| 305 | o Expanding 7z archives using LZMA compression could cause an |
| 306 | EOFException. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 307 | Issue: COMPRESS-286. |
Stefan Bodewig | de63306 | 2014-10-09 12:00:48 +0000 | [diff] [blame] | 308 | o Long-Name and -link or PAX-header entries in TAR archives always had |
| 309 | the current time as last modfication time, creating archives that |
| 310 | are different at the byte level each time an archive was built. |
| 311 | Issue: COMPRESS-289. |
| 312 | Thanks to Bob Robertson. |
| 313 | |
| 314 | Changes: |
| 315 | o Checking for XZ for Java may be expensive. The result will now be |
| 316 | cached outside of an OSGi environment. You can use the new |
| 317 | XZUtils#setCacheXZAvailability to overrride this default behavior. |
| 318 | Issue: COMPRESS-285. |
| 319 | |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 320 | Release 1.8.1 |
Stefan Bodewig | de63306 | 2014-10-09 12:00:48 +0000 | [diff] [blame] | 321 | ------------- |
Sebastian Bazley | 48882f1 | 2010-04-13 21:02:37 +0000 | [diff] [blame] | 322 | |
Stefan Bodewig | 48d7470 | 2013-03-10 17:10:57 +0000 | [diff] [blame] | 323 | New features: |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 324 | o COMPRESS-272: CompressorStreamFactory can now auto-detect Unix compress |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 325 | (".Z") streams. |
Stefan Bodewig | 48d7470 | 2013-03-10 17:10:57 +0000 | [diff] [blame] | 326 | |
Sebastian Bazley | 48882f1 | 2010-04-13 21:02:37 +0000 | [diff] [blame] | 327 | Fixed Bugs: |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 328 | o COMPRESS-270: The snappy, ar and tar inputstreams might fail to read from a |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 329 | non-buffered stream in certain cases. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 330 | o COMPRESS-277: IOUtils#skip might skip fewer bytes than requested even though |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 331 | more could be read from the stream. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 332 | o COMPRESS-276: ArchiveStreams now validate there is a current entry before |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 333 | reading or writing entry data. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 334 | o ArjArchiveInputStream#canReadEntryData tested the current |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 335 | entry of the stream rather than its argument. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 336 | o COMPRESS-274: ChangeSet#delete and deleteDir now properly deal with unnamed |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 337 | entries. |
| 338 | o COMPRESS-273: Added a few null checks to improve robustness. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 339 | o COMPRESS-278: TarArchiveInputStream failed to read archives with empty |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 340 | gid/uid fields. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 341 | o COMPRESS-279: TarArchiveInputStream now again throws an exception when it |
| 342 | encounters a truncated archive while reading from the last |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 343 | entry. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 344 | o COMPRESS-280: Adapted TarArchiveInputStream#skip to the modified |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 345 | IOUtils#skip method. Thanks to BELUGA BEHR. |
Stefan Bodewig | 48d7470 | 2013-03-10 17:10:57 +0000 | [diff] [blame] | 346 | |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 347 | Changes: |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 348 | o The dependency on org.tukaani:xz is now marked as optional. |
Stefan Bodewig | ec5eebf | 2014-05-09 18:28:42 +0000 | [diff] [blame] | 349 | |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 350 | Release 1.8 |
| 351 | ----------- |
| 352 | |
| 353 | New features: |
| 354 | o GzipCompressorInputStream now provides access to the same |
| 355 | metadata that can be provided via GzipParameters when writing |
| 356 | a gzip stream. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 357 | Issue: COMPRESS-260. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 358 | o SevenZOutputFile now supports chaining multiple |
| 359 | compression/encryption/filter methods and passing options to |
| 360 | the methods. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 361 | Issue: COMPRESS-266. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 362 | o The (compression) method(s) can now be specified per entry in |
| 363 | SevenZOutputFile. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 364 | Issue: COMPRESS-261. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 365 | o SevenZArchiveEntry "knows" which method(s) have been used to |
| 366 | write it to the archive. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 367 | Issue: COMPRESS-258. |
| 368 | o The 7z package now supports the delta filter as method. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 369 | o The 7z package now supports BCJ filters for several platforms. |
| 370 | You will need a version >= 1.5 of XZ for Java to read archives |
| 371 | using BCJ, though. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 372 | Issue: COMPRESS-257. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 373 | |
| 374 | Fixed Bugs: |
| 375 | o BZip2CompressorInputStream read fewer bytes than possible from |
| 376 | a truncated stream. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 377 | Issue: COMPRESS-253. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 378 | o SevenZFile failed claiming the dictionary was too large when |
| 379 | archives used LZMA compression for headers and content and |
| 380 | certain non-default dictionary sizes. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 381 | Issue: COMPRESS-253. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 382 | o CompressorStreamFactory.createCompressorInputStream with |
| 383 | explicit compression did not honor decompressConcatenated |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 384 | Issue: COMPRESS-259. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 385 | o TarArchiveInputStream will now read archives created by tar |
| 386 | implementations that encode big numbers by not adding a |
| 387 | trailing NUL. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 388 | Issue: COMPRESS-262. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 389 | o ZipArchiveInputStream would return NUL bytes for the first 512 |
| 390 | bytes of a STORED entry if it was the very first entry of the |
| 391 | archive. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 392 | Issue: COMPRESS-264. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 393 | o When writing PAX/POSIX headers for TAR entries with |
| 394 | backslashes or certain non-ASCII characters in their name |
| 395 | TarArchiveOutputStream could fail. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 396 | Issue: COMPRESS-265. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 397 | o ArchiveStreamFactory now throws a StreamingNotSupported - a |
| 398 | new subclass of ArchiveException - if it is asked to read from |
| 399 | or write to a stream and Commons Compress doesn't support |
| 400 | streaming for the format. This currently only applies to the |
| 401 | 7z format. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 402 | Issue: COMPRESS-267. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 403 | |
| 404 | Release 1.7 |
| 405 | ----------- |
| 406 | |
| 407 | New features: |
| 408 | o Read-Only support for Snappy compression. |
| 409 | Issue: COMPRESS-147. Thanks to BELUGA BEHR. |
| 410 | o Read-Only support for .Z compressed files. |
| 411 | Issue: COMPRESS-243. Thanks to Damjan Jovanovic. |
| 412 | o ZipFile and ZipArchiveInputStream now support reading entries |
| 413 | compressed using the SHRINKING method. Thanks to Damjan Jovanovic. |
| 414 | o GzipCompressorOutputStream now supports setting the compression |
| 415 | level and the header metadata (filename, comment, modification time, |
| 416 | operating system and extra flags) |
| 417 | Issue: COMPRESS-250. Thanks to Emmanuel Bourg. |
| 418 | o ZipFile and ZipArchiveInputStream now support reading entries |
| 419 | compressed using the IMPLODE method. |
| 420 | Issue: COMPRESS-115. Thanks to Emmanuel Bourg. |
| 421 | o ZipFile and the 7z file classes now implement Closeable and can be |
| 422 | used in try-with-resources constructs. |
| 423 | |
| 424 | Fixed Bugs: |
| 425 | o SevenZOutputFile#closeArchiveEntry throws an exception when using |
| 426 | LZMA2 compression on Java8. Issue: COMPRESS-241. |
| 427 | o 7z reading of big 64bit values could be wrong. |
| 428 | Issue: COMPRESS-244. Thanks to Nico Kruber. |
| 429 | o TarArchiveInputStream could fail to read an archive completely. |
| 430 | Issue: COMPRESS-245. |
| 431 | o The time-setters in X5455_ExtendedTimestamp now set the |
| 432 | corresponding flags explicitly - i.e. they set the bit if the valus |
| 433 | is not-null and reset it otherwise. This may cause |
| 434 | incompatibilities if you use setFlags to unset a bit and later set |
| 435 | the time to a non-null value - the flag will now be set. |
| 436 | Issue: COMPRESS-242. |
| 437 | o SevenZOutputFile would create invalid archives if more than six |
| 438 | empty files or directories were included. Issue: COMPRESS-252. |
| 439 | |
| 440 | Release 1.6 |
| 441 | ----------- |
| 442 | |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 443 | Version 1.6 introduces changes to the internal API of the tar package that |
| 444 | break backwards compatibility in the following rare cases. This version |
| 445 | removes the package private TarBuffer class along with the protected "buffer" |
| 446 | members in TarArchiveInputStream and TarArchiveOutputStream. This change will |
| 447 | only affect you if you have created a subclass of one of the stream classes |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 448 | and accessed the buffer member or directly used the TarBuffer class. |
| 449 | |
| 450 | Changes in this version include: |
| 451 | |
| 452 | New features: |
| 453 | o Added support for 7z archives. Most compression algorithms |
| 454 | can be read and written, LZMA and encryption are only |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 455 | supported when reading. Issue: COMPRESS-54. Thanks to Damjan Jovanovic. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 456 | o Added read-only support for ARJ archives that don't use |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 457 | compression. Issue: COMPRESS-226. Thanks to Damjan Jovanovic. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 458 | o DumpArchiveInputStream now supports an encoding parameter that |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 459 | can be used to specify the encoding of file names. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 460 | o The CPIO streams now support an encoding parameter that can be |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 461 | used to specify the encoding of file names. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 462 | o Read-only support for LZMA standalone compression has been added. |
| 463 | Issue: COMPRESS-111. |
| 464 | |
| 465 | Fixed Bugs: |
| 466 | o TarBuffer.tryToConsumeSecondEOFRecord could throw a |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 467 | NullPointerException Issue: COMPRESS-223. Thanks to Jeremy Gustie. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 468 | o Parsing of zip64 extra fields has become more lenient in order |
| 469 | to be able to read archives created by DotNetZip and maybe |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 470 | other archivers as well. Issue: COMPRESS-228. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 471 | o TAR will now properly read the names of symbolic links with |
| 472 | long names that use the GNU variant to specify the long file |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 473 | name. Issue: COMPRESS-229. Thanks to Christoph Gysin. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 474 | o ZipFile#getInputStream could return null if the archive |
| 475 | contained duplicate entries. |
| 476 | The class now also provides two new methods to obtain all |
| 477 | entries of a given name rather than just the first one. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 478 | Issue: COMPRESS-227. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 479 | o CpioArchiveInputStream failed to read archives created by |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 480 | Redline RPM. Issue: COMPRESS-236. Thanks to Andrew Duffy. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 481 | o TarArchiveOutputStream now properly handles link names that |
| 482 | are too long to fit into a traditional TAR header. Issue: |
| 483 | COMPRESS-237. Thanks to Emmanuel Bourg. |
| 484 | o The auto-detecting create*InputStream methods of Archive and |
| 485 | CompressorStreamFactory could fail to detect the format of |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 486 | blocking input streams. Issue: COMPRESS-239. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 487 | |
| 488 | Changes: |
| 489 | o Readabilty patch to TarArchiveInputStream. Issue: |
| 490 | COMPRESS-232. Thanks to BELUGA BEHR. |
| 491 | o Performance improvements to TarArchiveInputStream, in |
| 492 | particular to the skip method. Issue: COMPRESS-234. Thanks to |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 493 | BELUGA BEHR. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 494 | |
| 495 | Release 1.5 |
| 496 | ----------- |
| 497 | |
| 498 | New features: |
| 499 | |
| 500 | o CompressorStreamFactory has an option to create decompressing |
| 501 | streams that decompress the full input for formats that support |
| 502 | multiple concatenated streams. |
| 503 | Issue: COMPRESS-220. |
| 504 | |
| 505 | Fixed Bugs: |
| 506 | |
| 507 | o Typo in CompressorStreamFactory Javadoc |
| 508 | Issue: COMPRESS-218. |
| 509 | Thanks to Gili. |
| 510 | o ArchiveStreamFactory's tar stream detection created false positives |
| 511 | for AIFF files. |
| 512 | Issue: COMPRESS-191. |
| 513 | Thanks to Jukka Zitting. |
| 514 | o XZ for Java didn't provide an OSGi bundle. Compress' dependency on |
| 515 | it has now been marked optional so Compress itself can still be used |
| 516 | in an OSGi context. |
| 517 | Issue: COMPRESS-199. |
| 518 | Thanks to Jukka Zitting. |
| 519 | o When specifying the encoding explicitly TarArchiveOutputStream would |
| 520 | write unreadable names in GNU mode or even cause errors in POSIX |
| 521 | mode for file names longer than 66 characters. |
| 522 | Issue: COMPRESS-200. |
| 523 | Thanks to Christian Schlichtherle. |
| 524 | o Writing TAR PAX headers failed if the generated entry name ended |
| 525 | with a "/". |
| 526 | Issue: COMPRESS-203. |
| 527 | o ZipArchiveInputStream sometimes failed to provide input to the |
| 528 | Inflater when it needed it, leading to reads returning 0. |
| 529 | Issue: COMPRESS-189. |
| 530 | Thanks to Daniel Lowe. |
| 531 | o TarArchiveInputStream ignored the encoding for GNU long name |
| 532 | entries. |
| 533 | Issue: COMPRESS-212. |
| 534 | o TarArchiveInputStream could leave the second EOF record inside the |
| 535 | stream it had just finished reading. |
| 536 | Issue: COMPRESS-206. |
| 537 | Thanks to Peter De Maeyer. |
| 538 | o DumpArchiveInputStream no longer implicitly closes the original |
| 539 | input stream when it reaches the end of the archive. |
| 540 | o ZipArchiveInputStream now consumes the remainder of the archive when |
| 541 | getNextZipEntry returns null. |
| 542 | o Unit tests could fail if the source tree was checked out to a |
| 543 | directory tree containign spaces. |
| 544 | Issue: COMPRESS-205. |
| 545 | Thanks to Daniel Lowe. |
| 546 | o Fixed a potential ArrayIndexOutOfBoundsException when reading STORED |
| 547 | entries from ZipArchiveInputStream. |
| 548 | Issue: COMPRESS-219. |
| 549 | o CompressorStreamFactory can now be used without XZ for Java being |
| 550 | available. |
| 551 | Issue: COMPRESS-221. |
| 552 | |
| 553 | Changes: |
| 554 | |
| 555 | o Improved exception message if a zip archive cannot be read because |
| 556 | of an unsupported compression method. |
| 557 | Issue: COMPRESS-188. |
| 558 | Thanks to Harald Kuhn. |
| 559 | o ArchiveStreamFactory has a setting for file name encoding that sets |
| 560 | up encoding for ZIP and TAR streams. |
| 561 | Issue: COMPRESS-192. |
| 562 | Thanks to Jukka Zitting. |
| 563 | o TarArchiveEntry now has a method to verify its checksum. |
| 564 | Issue: COMPRESS-191. |
| 565 | Thanks to Jukka Zitting. |
| 566 | o Split/spanned ZIP archives are now properly detected by |
| 567 | ArchiveStreamFactory but will cause an |
| 568 | UnsupportedZipFeatureException when read. |
| 569 | o ZipArchiveInputStream now reads archives that start with a "PK00" |
| 570 | signature. Archives with this signatures are created when the |
| 571 | archiver was willing to split the archive but in the end only needed |
| 572 | a single segment - so didn't split anything. |
| 573 | Issue: COMPRESS-208. |
| 574 | o TarArchiveEntry has a new constructor that allows setting linkFlag |
| 575 | and preserveLeadingSlashes at the same time. |
| 576 | Issue: COMPRESS-201. |
| 577 | o ChangeSetPerformer has a new perform overload that uses a ZipFile |
| 578 | instance as input. |
| 579 | Issue: COMPRESS-159. |
| 580 | o Garbage collection pressure has been reduced by reusing temporary |
| 581 | byte arrays in classes. |
| 582 | Issue: COMPRESS-172. |
| 583 | Thanks to Thomas Mair. |
| 584 | o Can now handle zip extra field 0x5455 - Extended Timestamp. |
| 585 | Issue: COMPRESS-210. |
| 586 | Thanks to Julius Davies. |
| 587 | o handle zip extra field 0x7875 - Info Zip New Unix Extra Field. |
| 588 | Issue: COMPRESS-211. |
| 589 | Thanks to Julius Davies. |
| 590 | o ZipShort, ZipLong, ZipEightByteInteger should implement Serializable |
| 591 | Issue: COMPRESS-213. |
| 592 | Thanks to Julius Davies. |
| 593 | o better support for unix symlinks in ZipFile entries. |
| 594 | Issue: COMPRESS-214. |
| 595 | Thanks to Julius Davies. |
| 596 | o ZipFile's initialization has been improved for non-Zip64 archives. |
| 597 | Issue: COMPRESS-215. |
| 598 | Thanks to Robin Power. |
| 599 | o Updated XZ for Java dependency to 1.2 as this version provides |
| 600 | proper OSGi manifest attributes. |
| 601 | |
| 602 | Release 1.4.1 |
| 603 | ------------- |
| 604 | |
| 605 | This is a security bugfix release, see |
| 606 | http://commons.apache.org/proper/commons-compress/security.html#Fixed_in_Apache_Commons_Compress_1.4.1 |
| 607 | |
| 608 | Fixed Bugs: |
| 609 | |
| 610 | o Ported libbzip2's fallback sort algorithm to |
| 611 | BZip2CompressorOutputStream to speed up compression in certain |
| 612 | edge cases. |
| 613 | |
| 614 | Release 1.4 |
| 615 | ----------- |
| 616 | |
| 617 | New features: |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 618 | o COMPRESS-156: Support for the XZ format has been added. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 619 | |
| 620 | Fixed Bugs: |
| 621 | o COMPRESS-183: The tar package now allows the encoding of file names to be |
| 622 | specified and can optionally use PAX extension headers to |
| 623 | write non-ASCII file names. |
| 624 | The stream classes now write (or expect to read) archives that |
| 625 | use the platform's native encoding for file names. Apache |
| 626 | Commons Compress 1.3 used to strip everything but the lower |
| 627 | eight bits of each character which effectively only worked for |
| 628 | ASCII and ISO-8859-1 file names. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 629 | This new default behavior is a breaking change. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 630 | o COMPRESS-184: TarArchiveInputStream failed to parse PAX headers that |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 631 | contained non-ASCII characters. |
| 632 | o COMPRESS-178: TarArchiveInputStream throws IllegalArgumentException instead of IOException |
| 633 | o COMPRESS-179: TarUtils.formatLongOctalOrBinaryBytes() assumes the field will be 12 bytes long |
| 634 | o COMPRESS-175: GNU Tar sometimes uses binary encoding for UID and GID |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 635 | o COMPRESS-171: ArchiveStreamFactory.createArchiveInputStream would claim |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 636 | short text files were TAR archives. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 637 | o COMPRESS-164: ZipFile didn't work properly for archives using unicode extra |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 638 | fields rather than UTF-8 filenames and the EFS-Flag. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 639 | o COMPRESS-169: For corrupt archives ZipFile would throw a RuntimeException in |
| 640 | some cases and an IOException in others. It will now |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 641 | consistently throw an IOException. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 642 | |
| 643 | Changes: |
| 644 | o COMPRESS-182: The tar package can now write archives that use star/GNU/BSD |
| 645 | extensions or use the POSIX/PAX variant to store numeric |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 646 | values that don't fit into the traditional header fields. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 647 | o COMPRESS-181: Added a workaround for a Bug some tar implementations that add |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 648 | a NUL byte as first byte in numeric header fields. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 649 | o COMPRESS-176: Added a workaround for a Bug in WinZIP which uses backslashes |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 650 | as path separators in Unicode Extra Fields. |
| 651 | o COMPRESS-131: ArrayOutOfBounds while decompressing bz2. Added test case - code already seems to have been fixed. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 652 | o COMPRESS-146: BZip2CompressorInputStream now optionally supports reading of |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 653 | concatenated .bz2 files. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 654 | o COMPRESS-154: GZipCompressorInputStream now optionally supports reading of |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 655 | concatenated .gz files. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 656 | o COMPRESS-16: The tar package can now read archives that use star/GNU/BSD |
| 657 | extensions for files that are longer than 8 GByte as well as |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 658 | archives that use the POSIX/PAX variant. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 659 | o COMPRESS-165: The tar package can now write archives that use star/GNU/BSD |
| 660 | extensions for files that are longer than 8 GByte as well as |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 661 | archives that use the POSIX/PAX variant. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 662 | o COMPRESS-166: The tar package can now use the POSIX/PAX variant for writing |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 663 | entries with names longer than 100 characters. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 664 | |
| 665 | Release 1.3 |
| 666 | ----------- |
| 667 | |
| 668 | Commons Compress 1.3 is the first version to require Java5 at runtime. |
| 669 | |
| 670 | Changes in this version include: |
| 671 | |
| 672 | New features: |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 673 | o Support for the Pack200 format has been added. Issue: COMPRESS-142. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 674 | o Read-only support for the format used by the Unix dump(8) tool |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 675 | has been added. Issue: COMPRESS-132. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 676 | |
| 677 | Fixed Bugs: |
| 678 | o BZip2CompressorInputStream's getBytesRead method always |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 679 | returned 0. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 680 | o ZipArchiveInputStream and ZipArchiveOutputStream could leak |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 681 | resources on some JDKs. Issue: COMPRESS-152. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 682 | o TarArchiveOutputStream's getBytesWritten method didn't count |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 683 | correctly. Issue: COMPRESS-160. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 684 | |
| 685 | Changes: |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 686 | o The ZIP package now supports Zip64 extensions. Issue: COMPRESS-36. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 687 | o The AR package now supports the BSD dialect of storing file |
| 688 | names longer than 16 chars (both reading and writing). |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 689 | Issue: COMPRESS-144. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 690 | |
| 691 | Release 1.2 |
| 692 | ----------- |
| 693 | |
| 694 | New features: |
| 695 | o COMPRESS-123: ZipArchiveEntry has a new method getRawName that provides the |
| 696 | original bytes that made up the name. This may allow user |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 697 | code to detect the encoding. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 698 | o COMPRESS-122: TarArchiveEntry provides access to the flags that determine |
| 699 | whether it is an archived symbolic link, pipe or other |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 700 | "uncommon" file system object. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 701 | |
| 702 | Fixed Bugs: |
| 703 | o COMPRESS-129: ZipArchiveInputStream could fail with a "Truncated ZIP" error |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 704 | message for entries between 2 GByte and 4 GByte in size. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 705 | o COMPRESS-145: TarArchiveInputStream now detects sparse entries using the |
| 706 | oldgnu format and properly reports it cannot extract their |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 707 | contents. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 708 | o COMPRESS-130: The Javadoc for ZipArchiveInputStream#skip now matches the |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 709 | implementation, the code has been made more defensive. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 710 | o COMPRESS-140: ArArchiveInputStream fails if entries contain only blanks for |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 711 | userId or groupId. Thanks to Trejkaz. |
| 712 | o COMPRESS-139: ZipFile may leak resources on some JDKs. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 713 | o COMPRESS-125: BZip2CompressorInputStream throws IOException if |
| 714 | underlying stream returns available() == 0. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 715 | Removed the check. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 716 | o COMPRESS-127: Calling close() on inputStream returned by |
| 717 | CompressorStreamFactory.createCompressorInputStream() |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 718 | does not close the underlying input stream. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 719 | o COMPRESS-119: TarArchiveOutputStream#finish now writes all buffered |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 720 | data to the stream |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 721 | |
| 722 | Changes: |
| 723 | o ZipFile now implements finalize which closes the underlying |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 724 | file. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 725 | o COMPRESS-117: Certain tar files not recognised by |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 726 | ArchiveStreamFactory. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 727 | |
| 728 | Release 1.1 |
| 729 | ----------- |
| 730 | |
| 731 | New features: |
| 732 | o COMPRESS-108: Command-line interface to list archive contents. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 733 | Usage: java -jar commons-compress-n.m.jar archive-name [zip|tar|etc] |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 734 | o COMPRESS-109: Tar implementation does not support Pax headers |
| 735 | Added support for reading pax headers. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 736 | Note: does not support global pax headers |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 737 | o COMPRESS-103: ZipArchiveInputStream can optionally extract data that used |
| 738 | the STORED compression method and a data descriptor. |
| 739 | Doing so in a stream is not safe in general, so you have to |
| 740 | explicitly enable the feature. By default the stream will |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 741 | throw an exception if it encounters such an entry. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 742 | o COMPRESS-98: The ZIP classes will throw specialized exceptions if any |
| 743 | attempt is made to read or write data that uses zip features |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 744 | not supported (yet). |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 745 | o COMPRESS-99: ZipFile#getEntries returns entries in a predictable order - |
| 746 | the order they appear inside the central directory. |
| 747 | A new method getEntriesInPhysicalOrder returns entries in |
| 748 | order of the entry data, i.e. the order ZipArchiveInputStream |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 749 | would see. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 750 | o The Archive*Stream and ZipFile classes now have |
| 751 | can(Read|Write)EntryData methods that can be used to check |
| 752 | whether a given entry's data can be read/written. |
| 753 | The method currently returns false for ZIP archives if an |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 754 | entry uses an unsupported compression method or encryption. |
| 755 | o COMPRESS-89: The ZIP classes now detect encrypted entries. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 756 | o COMPRESS-97: Added autodetection of compression format to |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 757 | CompressorStreamFactory. |
| 758 | o COMPRESS-95: Improve ExceptionMessages in ArchiveStreamFactory Thanks to Joerg Bellmann. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 759 | o A new constructor of TarArchiveEntry can create entries with |
| 760 | names that start with slashes - the default is to strip |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 761 | leading slashes in order to create relative path names. |
| 762 | o ArchiveEntry now has a getLastModifiedDate method. |
| 763 | o COMPRESS-78: Add a BZip2Utils class modelled after GZipUtils Thanks to Jukka Zitting. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 764 | |
| 765 | Fixed Bugs: |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 766 | o COMPRESS-72: Move acknowledgements from NOTICE to README |
| 767 | o COMPRESS-113: TarArchiveEntry.parseTarHeader() includes the trailing space/NUL when parsing the octal size |
| 768 | o COMPRESS-118: TarUtils.parseName does not properly handle characters outside the range 0-127 |
| 769 | o COMPRESS-107: ArchiveStreamFactory does not recognise tar files created by Ant |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 770 | o COMPRESS-110: Support "ustar" prefix field, which is used when file paths are longer |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 771 | than 100 characters. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 772 | o COMPRESS-100: ZipArchiveInputStream will throw an exception if it detects an |
| 773 | entry that uses a data descriptor for a STORED entry since it |
| 774 | cannot reliably find the end of data for this "compression" |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 775 | method. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 776 | o COMPRESS-101: ZipArchiveInputStream should now properly read archives that |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 777 | use data descriptors but without the "unofficial" signature. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 778 | o COMPRESS-74: ZipArchiveInputStream failed to update the number of bytes |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 779 | read properly. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 780 | o ArchiveInputStream has a new method getBytesRead that should |
| 781 | be preferred over getCount since the later may truncate the |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 782 | number of bytes read for big archives. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 783 | o COMPRESS-85: The cpio archives created by CpioArchiveOutputStream couldn't |
| 784 | be read by many existing native implementations because the |
| 785 | archives contained multiple entries with the same inode/device |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 786 | combinations and weren't padded to a blocksize of 512 bytes. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 787 | o COMPRESS-73: ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 788 | more lenient when parsing extra fields. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 789 | o COMPRESS-82: cpio is terribly slow. |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 790 | Documented that buffered streams are needed for performance |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 791 | o Improved exception message if the extra field data in ZIP |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 792 | archives cannot be parsed. |
| 793 | o COMPRESS-17: Tar format unspecified - current support documented. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 794 | o COMPRESS-94: ZipArchiveEntry's equals method was broken for entries created |
| 795 | with the String-arg constructor. This lead to broken ZIP |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 796 | archives if two different entries had the same hash code. Thanks to Anon Devs. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 797 | o COMPRESS-87: ZipArchiveInputStream could repeatedly return 0 on read() when |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 798 | the archive was truncated. Thanks to Antoni Mylka. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 799 | o COMPRESS-86: Tar archive entries holding the file name for names longer |
| 800 | than 100 characters in GNU longfile mode didn't properly |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 801 | specify they'd be using the "oldgnu" extension. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 802 | o COMPRESS-83: Delegate all read and write methods in GZip stream in order to |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 803 | speed up operations. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 804 | o The ar and cpio streams now properly read and write last |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 805 | modified times. |
| 806 | o COMPRESS-81: TarOutputStream can leave garbage at the end of the archive |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 807 | |
| 808 | Changes: |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 809 | o COMPRESS-112: ArArchiveInputStream does not handle GNU extended filename records (//) |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 810 | o COMPRESS-105: Document that the name of an ZipArchiveEntry determines whether |
| 811 | an entry is considered a directory or not. |
| 812 | If you don't use the constructor with the File argument the entry's |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 813 | name must end in a "/" in order for the entry to be known as a directory. |
| 814 | o COMPRESS-79: Move DOS/Java time conversions into Zip utility class. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 815 | o COMPRESS-75: ZipArchiveInputStream does not show location in file |
Torsten Curdt | ce9e0ce | 2016-01-15 15:31:59 +0100 | [diff] [blame] | 816 | where a problem occurred. |
Stefan Bodewig | 0b71b47 | 2014-10-05 13:36:58 +0000 | [diff] [blame] | 817 | |