blob: 602f1fb5fca7ee4badcea0422b5678b47dbac3e2 [file] [log] [blame]
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +00001<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 Licensed to the Apache Software Foundation (ASF) under one
4 or more contributor license agreements. See the NOTICE file
5 distributed with this work for additional information
6 regarding copyright ownership. The ASF licenses this file
7 to you under the Apache License, Version 2.0 (the
8 "License"); you may not use this file except in compliance
9 with the License. You may obtain a copy of the License at
10
11 http://www.apache.org/licenses/LICENSE-2.0
12
13 Unless required by applicable law or agreed to in writing,
14 software distributed under the License is distributed on an
15 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 KIND, either express or implied. See the License for the
17 specific language governing permissions and limitations
18 under the License.
19-->
Sebastian Bazley48882f12010-04-13 21:02:37 +000020
21<!--
22This file is also used by the maven-changes-plugin to generate the release notes.
23Useful ways of finding items to add to this file are:
24
Sebastian Bazley27dea242010-05-10 17:42:37 +0000251. Add items when you fix a bug or add a feature (this makes the
Sebastian Bazley48882f12010-04-13 21:02:37 +000026release process easy :-).
27
282. Do a JIRA search for tickets closed since the previous release.
29
303. Use the report generated by the maven-changelog-plugin to see all
31SVN commits. TBA how to use this with SVN.
32
33To generate the release notes from this file:
34
Sebastian Bazley6021ccb2010-04-14 00:49:28 +000035mvn changes:announcement-generate -Prelnotes
Sebastian Bazley48882f12010-04-13 21:02:37 +000036mv target/announcement/release-notes.vm RELEASE-NOTES.txt
Sebastian Bazley27dea242010-05-10 17:42:37 +000037then tweak the formatting if necessary and commit
Sebastian Bazley48882f12010-04-13 21:02:37 +000038
39The <action> type attribute can be add,update,fix,remove.
40-->
41
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +000042<document>
43 <properties>
44 <title>commons-compress</title>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +000045 </properties>
46 <body>
Stefan Bodewig3447a362011-11-01 06:16:11 +000047 <release version="1.4" date="unreleased"
48 description="Release 1.4">
Stefan Bodewige166fa72011-11-03 06:32:25 +000049 <action issue="COMPRESS-156" type="add" date="2011-11-02">
50 Support for the XZ format has been added.
51 </action>
Stefan Bodewig20fd83a2011-11-07 16:36:51 +000052 <action issue="COMPRESS-146" type="update" date="2011-11-07">
53 BZip2CompressorInputStream now optionally supports reading of
54 concatenated .bz2 files.
55 </action>
Stefan Bodewigfa237cc2011-11-09 16:18:05 +000056 <action issue="COMPRESS-154" type="update" date="2011-11-09">
57 GZipCompressorInputStream now optionally supports reading of
58 concatenated .gz files.
59 </action>
Stefan Bodewig68465642011-12-05 09:58:04 +000060 <action issue="COMPRESS-16" type="update" date="2011-12-05">
61 The tar package can now read archives that use GNU extensions
62 for files that are longer than 8 GByte.
63 </action>
Stefan Bodewig34766062011-12-05 15:39:52 +000064 <action issue="COMPRESS-164" type="fix" date="2011-12-05">
65 ZipFile didn't work properly for archives using unicode extra
66 fields rather than UTF-8 filenames and the EFS-Flag.
67 </action>
Stefan Bodewig3447a362011-11-01 06:16:11 +000068 </release>
69 <release version="1.3" date="2011-11-01"
Stefan Bodewig7df24262011-07-31 05:43:43 +000070 description="Release 1.3 - API compatible to 1.2 but requires Java5 at runtime">
Stefan Bodewigf4ff2002011-09-14 15:03:35 +000071 <action issue="COMPRESS-142" type="add" date="2011-09-14">
72 Support for the Pack200 format has been added.
73 </action>
Stefan Bodewig67248f02011-08-22 05:47:26 +000074 <action issue="COMPRESS-132" type="add" date="2011-08-17">
75 Read-only support for the format used by the Unix dump(8) tool
76 has been added.
77 </action>
Stefan Bodewig3ae0c502011-08-15 04:13:10 +000078 <action issue="COMPRESS-36" type="update" date="2011-08-15">
79 The ZIP package now supports Zip64 extensions.
80 </action>
Stefan Bodewig1b915c72011-08-08 11:39:41 +000081 <action issue="COMPRESS-144" type="update" date="2011-08-08">
82 The AR package now supports the BSD dialect of storing file
83 names longer than 16 chars (both reading and writing).
84 </action>
Stefan Bodewig02991912011-08-08 04:41:15 +000085 <action type="fix" date="2011-08-08">
Stefan Bodewigc84526b2011-08-08 05:09:25 +000086 BZip2CompressorInputStream's getBytesRead method always
Stefan Bodewig02991912011-08-08 04:41:15 +000087 returned 0.
88 </action>
Stefan Bodewigd48f1062011-08-03 13:36:01 +000089 <action issue="COMPRESS-152" type="fix" date="2011-08-03">
90 ZipArchiveInputStream and ZipArchiveOutputStream could leak
91 resources on some JDKs.
92 </action>
Stefan Bodewigfdac1472011-10-23 12:15:13 +000093 <action issue="COMPRESS-160" type="fix" date="2011-10-23">
94 TarArchiveOutputStream's getBytesWritten method didn't count
95 correctly.
96 </action>
Stefan Bodewig7df24262011-07-31 05:43:43 +000097 </release>
98 <release version="1.2" date="2011-07-31"
Stefan Bodewig947e9832011-07-27 03:53:35 +000099 description="Release 1.2 - a bugfix release, the last release expected to be compatible with Java 1.4">
Stefan Bodewiga9bd2e22011-07-26 14:12:44 +0000100 <action issue="COMPRESS-129" type="fix" date="2011-07-26">
101 ZipArchiveInputStream could fail with a "Truncated ZIP" error
102 message for entries between 2 GByte and 4 GByte in size.
103 </action>
Stefan Bodewigeedeff92011-07-23 04:57:17 +0000104 <action issue="COMPRESS-145" type="fix" date="2011-07-23"
105 due-tue="Patrick Dreyer">
Stefan Bodewig2b90da62011-07-25 05:54:45 +0000106 TarArchiveInputStream now detects sparse entries using the
107 oldgnu format and properly reports it cannot extract their
108 contents.
Stefan Bodewigeedeff92011-07-23 04:57:17 +0000109 </action>
110 <action issue="COMPRESS-123" type="add" date="2011-07-23">
Stefan Bodewig934a96e2011-07-23 04:33:44 +0000111 ZipArchiveEntry has a new method getRawName that provides the
112 original bytes that made up the name. This may allow user
113 code to detect the encoding.
114 </action>
Stefan Bodewig7a76c472011-07-20 14:55:50 +0000115 <action issue="COMPRESS-130" type="fix" date="2011-07-20">
116 The Javadoc for ZipArchiveInputStream#skip now matches the
117 implementation, the code has been made more defensive.
118 </action>
Stefan Bodewig541898f2011-07-20 14:23:20 +0000119 <action issue="COMPRESS-140" type="fix" date="2011-07-20"
120 due-to="Trejkaz">
121 ArArchiveInputStream fails if entries contain only blanks for
122 userId or groupId.
123 </action>
Stefan Bodewigb4d75052011-07-13 13:53:18 +0000124 <action issue="COMPRESS-139" type="fix" date="2011-07-13">
125 ZipFile may leak resources on some JDKs.
126 </action>
Stefan Bodewig8c2e5e62011-04-18 04:28:14 +0000127 <action type="update" date="2011-04-18">
128 ZipFile now implements finalize which closes the underlying
129 file.
130 </action>
Sebastian Bazley60d6b6a2011-03-23 12:50:15 +0000131 <action issue="COMPRESS-117" type="update" date="2011-03-23">
132 Certain tar files not recognised by ArchiveStreamFactory.
133 </action>
Sebastian Bazley9f68b5d2011-03-23 11:17:25 +0000134 <action issue="COMPRESS-125" type="fix" date="2011-03-23">
135 BZip2CompressorInputStream throws IOException if underlying stream returns available() == 0.
136 Removed the check.
137 </action>
Sebastian Bazley8376ecf2011-03-23 11:06:43 +0000138 <action issue="COMPRESS-127" type="fix" date="2011-03-23">
139 Calling close() on inputStream returned by CompressorStreamFactory.createCompressorInputStream()
140 does not close the underlying input stream.
141 </action>
Stefan Bodewig86aaf842010-10-29 15:03:49 +0000142 <action issue="COMPRESS-122" type="add" date="2010-10-29">
143 TarArchiveEntry provides access to the flags that determine
144 whether it is an archived symbolic link, pipe or other
145 "uncommon" file system object.
146 </action>
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +0000147 <action issue="COMPRESS-119" type="fix" date="2010-10-26">
Sebastian Bazley7dd43012010-10-28 14:15:27 +0000148 TarArchiveOutputStream#finish now writes all buffered data to the stream
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +0000149 </action>
150 </release>
151 <release version="1.1" date="2010-08-13" description="Release 1.1">
Sebastian Bazley75c87112010-06-02 11:15:23 +0000152 <action issue="COMPRESS-72" type="fix" date="2010-06-02">
153 Move acknowledgements from NOTICE to README
154 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +0000155 <action issue="COMPRESS-113" type="fix" date="2010-06-02">
156 TarArchiveEntry.parseTarHeader() includes the trailing space/NUL when parsing the octal size
157 </action>
158 <action issue="COMPRESS-108" type="add" date="2010-05-23">
Sebastian Bazleydfc66382010-05-23 11:53:07 +0000159 Command-line interface to list archive contents.
160 Usage: java -jar commons-compress-n.m.jar archive-name [zip|tar|etc]
161 </action>
Sebastian Bazley050db3d2010-05-17 15:09:29 +0000162 <action issue="COMPRESS-118" type="fix" date="2010-05-17">
163 TarUtils.parseName does not properly handle characters outside the range 0-127
164 </action>
Sebastian Bazleyc83d9f72010-05-13 10:25:15 +0000165 <action issue="COMPRESS-112" type="update" date="2010-05-13">
166 ArArchiveInputStream does not handle GNU extended filename records (//)
167 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +0000168 <action issue="COMPRESS-109" type="add" date="2010-05-10">
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000169 Tar implementation does not support Pax headers
170 Added support for reading pax headers.
171 Note: does not support global pax headers
Sebastian Bazley27dea242010-05-10 17:42:37 +0000172 </action>
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000173 <action issue="COMPRESS-107" type="fix" date="2010-05-10">
174 ArchiveStreamFactory does not recognise tar files created by Ant
Sebastian Bazley27dea242010-05-10 17:42:37 +0000175 </action>
Sebastian Bazley8fcd06e2010-05-09 20:46:59 +0000176 <action issue="COMPRESS-110" type="fix" date="2010-05-09">
177 Support "ustar" prefix field, which is used when file paths are longer
178 than 100 characters.
Sebastian Bazley27dea242010-05-10 17:42:37 +0000179 </action>
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000180 <action type="update" date="2010-04-19" issue="COMPRESS-105">
181 Document that the name of an ZipArchiveEntry determines whether
Sebastian Bazley27dea242010-05-10 17:42:37 +0000182 an entry is considered a directory or not.
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000183 If you don't use the constructor with the File argument the entry's
184 name must end in a "/" in order for the entry to be known as a directory.
185 </action>
Stefan Bodewig03e94a42010-03-19 15:08:23 +0000186 <action type="add" date="2010-03-19" issue="COMPRESS-103">
187 ZipArchiveInputStream can optionally extract data that used
188 the STORED compression method and a data descriptor.
189 Doing so in a stream is not safe in general, so you have to
190 explicitly enable the feature. By default the stream will
191 throw an exception if it encounters such an entry.
192 </action>
Stefan Bodewig62cb9c42010-03-12 16:06:20 +0000193 <action type="fix" date="2010-03-12" issue="COMPRESS-100">
194 ZipArchiveInputStream will throw an exception if it detects an
195 entry that uses a data descriptor for a STORED entry since it
196 cannot reliably find the end of data for this "compression"
197 method.
198 </action>
Stefan Bodewigd7ea9ff2010-03-12 15:35:44 +0000199 <action type="fix" date="2010-03-12" issue="COMPRESS-101">
200 ZipArchiveInputStream should now properly read archives that
201 use data descriptors but without the "unofficial" signature.
202 </action>
Stefan Bodewig30e1cc82010-03-09 11:23:41 +0000203 <action type="add" date="2010-03-09" issue="COMPRESS-98">
204 The ZIP classes will throw specialized exceptions if any
205 attempt is made to read or write data that uses zip features
206 not supported (yet).
207 </action>
Stefan Bodewigade93792010-03-08 12:00:25 +0000208 <action type="add" date="2010-03-08" issue="COMPRESS-99">
209 ZipFile#getEntries returns entries in a predictable order -
210 the order they appear inside the central directory.
211 A new method getEntriesInPhysicalOrder returns entries in
212 order of the entry data, i.e. the order ZipArchiveInputStream
213 would see.
214 </action>
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000215 <action type="add" date="2010-02-19">
Stefan Bodewige0692ec2010-02-24 15:35:47 +0000216 The Archive*Stream and ZipFile classes now have
217 can(Read|Write)EntryData methods that can be used to check
218 whether a given entry's data can be read/written.
Stefan Bodewiga33505b2010-02-19 12:23:27 +0000219 The method currently returns false for ZIP archives if an
220 entry uses an unsupported compression method or encryption.
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000221 </action>
222 <action type="add" date="2010-02-19" issue="COMPRESS-89">
223 The ZIP classes now detect encrypted entries.
224 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000225 <action type="update" date="2010-02-18" issue="COMPRESS-79">
226 Move DOS/Java time conversions into Zip utility class.
227 </action>
Stefan Bodewiga1015f32010-02-18 16:11:13 +0000228 <action type="fix" date="2010-02-18" issue="COMPRESS-74">
229 ZipArchiveInputStream failed to update the number of bytes
230 read properly.
231 </action>
232 <action type="fix" date="2010-02-18">
233 ArchiveInputStream has a new method getBytesRead that should
234 be preferred over getCount since the later may truncate the
235 number of bytes read for big archives.
236 </action>
Stefan Bodewig315b9472010-02-18 14:56:03 +0000237 <action type="fix" date="2010-02-18" issue="COMPRESS-85">
238 The cpio archives created by CpioArchiveOutputStream couldn't
239 be read by many existing native implementations because the
240 archives contained multiple entries with the same inode/device
241 combinations and weren't padded to a blocksize of 512 bytes.
242 </action>
Stefan Bodewig91695e42010-02-16 13:59:03 +0000243 <action type="fix" date="2010-02-16" issue="COMPRESS-73">
244 ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now
245 more lenient when parsing extra fields.
246 </action>
Sebastian Bazley78e0f2c2010-06-01 16:38:13 +0000247 <action issue="COMPRESS-75" type="update" date="2010-02-12">
248 ZipArchiveInputStream does not show location in file where a problem occurred.
249 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000250 <action type="fix" date="2010-02-12" issue="COMPRESS-82">
251 cpio is terribly slow.
252 Documented that buffered streams are needed for performance
253 </action>
Stefan Bodewig292e1852010-03-04 15:54:09 +0000254 <action type="add" date="2010-02-12" issue="COMPRESS-97">
255 Added autodetection of compression format to
256 CompressorStreamFactory.
257 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000258 <action type="fix" date="2010-02-12">
259 Improved exception message if the extra field data in ZIP
260 archives cannot be parsed.
261 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000262 <action type="fix" date="2010-02-11" issue="COMPRESS-17">
263 Tar format unspecified - current support documented.
264 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000265 <action type="add" issue="COMPRESS-95" date="2010-01-29"
Christian Grobmeiere7517b82010-01-29 07:47:21 +0000266 due-to="Joerg Bellmann">
267 Improve ExceptionMessages in ArchiveStreamFactory
268 </action>
Stefan Bodewig5066e9a2010-01-07 09:34:55 +0000269 <action type="fix" issue="COMPRESS-94" date="2010-01-07"
270 due-to="Anon Devs">
271 ZipArchiveEntry's equals method was broken for entries created
272 with the String-arg constructor. This lead to broken ZIP
273 archives if two different entries had the same hash code.
274 </action>
Stefan Bodewigdc3fc472009-10-30 05:29:17 +0000275 <action type="fix" issue="COMPRESS-87" date="2009-10-30"
276 due-to="Antoni Mylka">
277 ZipArchiveInputStream could repeatedly return 0 on read() when
278 the archive was truncated.
279 </action>
Stefan Bodewig7bb5d882009-10-08 12:07:19 +0000280 <action type="fix" issue="COMPRESS-86" date="2009-10-08">
281 Tar archive entries holding the file name for names longer
282 than 100 characters in GNU longfile mode didn't properly
283 specify they'd be using the "oldgnu" extension.
284 </action>
Stefan Bodewig3e2ddad2009-08-25 08:11:44 +0000285 <action type="add" date="2009-08-25">
286 A new constructor of TarArchiveEntry can create entries with
287 names that start with slashes - the default is to strip
288 leading slashes in order to create relative path names.
289 </action>
Stefan Bodewig7be8ef62009-08-01 20:25:13 +0000290 <action issue="COMPRESS-83" type="fix" date="2009-08-01">
291 Delegate all read and write methods in GZip stream in order to
292 speed up operations.
293 </action>
294 <action type="add" date="2009-08-01">
295 ArchiveEntry now has a getLastModifiedDate method.
296 </action>
297 <action type="fix" date="2009-08-01">
298 The ar and cpio streams now properly read and write last
299 modified times.
300 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000301 <action issue="COMPRESS-81" type="fix" date="2009-06-30">
302 TarOutputStream can leave garbage at the end of the archive
303 </action>
Stefan Bodewig47b706e2009-06-30 08:23:08 +0000304 <action issue="COMPRESS-78" type="add" date="2009-06-30"
305 due-to="Jukka Zitting">
306 Add a BZip2Utils class modelled after GZipUtils
307 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000308 </release>
309 <release version="1.0" date="2009-05-21" description="First Public Release">
310 <action dev="all" type="add" date="2009-05-21">
Christian Grobmeier35ac05e2009-05-10 17:32:20 +0000311 Initial release
312 </action>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +0000313 <action dev="sgoeschl" type="fix">
314 Updating the pom.xml for preparing a move to commons-proper
315 </action>
316 </release>
317 </body>
318</document>