blob: 63068553874b33c098872a2057d10351e0b792a8 [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 Bodewig7df24262011-07-31 05:43:43 +000047 <release version="1.3" date="unreleased"
48 description="Release 1.3 - API compatible to 1.2 but requires Java5 at runtime">
Stefan Bodewigd48f1062011-08-03 13:36:01 +000049 <action issue="COMPRESS-152" type="fix" date="2011-08-03">
50 ZipArchiveInputStream and ZipArchiveOutputStream could leak
51 resources on some JDKs.
52 </action>
Stefan Bodewig7df24262011-07-31 05:43:43 +000053 </release>
54 <release version="1.2" date="2011-07-31"
Stefan Bodewig947e9832011-07-27 03:53:35 +000055 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 +000056 <action issue="COMPRESS-129" type="fix" date="2011-07-26">
57 ZipArchiveInputStream could fail with a "Truncated ZIP" error
58 message for entries between 2 GByte and 4 GByte in size.
59 </action>
Stefan Bodewigeedeff92011-07-23 04:57:17 +000060 <action issue="COMPRESS-145" type="fix" date="2011-07-23"
61 due-tue="Patrick Dreyer">
Stefan Bodewig2b90da62011-07-25 05:54:45 +000062 TarArchiveInputStream now detects sparse entries using the
63 oldgnu format and properly reports it cannot extract their
64 contents.
Stefan Bodewigeedeff92011-07-23 04:57:17 +000065 </action>
66 <action issue="COMPRESS-123" type="add" date="2011-07-23">
Stefan Bodewig934a96e2011-07-23 04:33:44 +000067 ZipArchiveEntry has a new method getRawName that provides the
68 original bytes that made up the name. This may allow user
69 code to detect the encoding.
70 </action>
Stefan Bodewig7a76c472011-07-20 14:55:50 +000071 <action issue="COMPRESS-130" type="fix" date="2011-07-20">
72 The Javadoc for ZipArchiveInputStream#skip now matches the
73 implementation, the code has been made more defensive.
74 </action>
Stefan Bodewig541898f2011-07-20 14:23:20 +000075 <action issue="COMPRESS-140" type="fix" date="2011-07-20"
76 due-to="Trejkaz">
77 ArArchiveInputStream fails if entries contain only blanks for
78 userId or groupId.
79 </action>
Stefan Bodewigb4d75052011-07-13 13:53:18 +000080 <action issue="COMPRESS-139" type="fix" date="2011-07-13">
81 ZipFile may leak resources on some JDKs.
82 </action>
Stefan Bodewig8c2e5e62011-04-18 04:28:14 +000083 <action type="update" date="2011-04-18">
84 ZipFile now implements finalize which closes the underlying
85 file.
86 </action>
Sebastian Bazley60d6b6a2011-03-23 12:50:15 +000087 <action issue="COMPRESS-117" type="update" date="2011-03-23">
88 Certain tar files not recognised by ArchiveStreamFactory.
89 </action>
Sebastian Bazley9f68b5d2011-03-23 11:17:25 +000090 <action issue="COMPRESS-125" type="fix" date="2011-03-23">
91 BZip2CompressorInputStream throws IOException if underlying stream returns available() == 0.
92 Removed the check.
93 </action>
Sebastian Bazley8376ecf2011-03-23 11:06:43 +000094 <action issue="COMPRESS-127" type="fix" date="2011-03-23">
95 Calling close() on inputStream returned by CompressorStreamFactory.createCompressorInputStream()
96 does not close the underlying input stream.
97 </action>
Stefan Bodewig86aaf842010-10-29 15:03:49 +000098 <action issue="COMPRESS-122" type="add" date="2010-10-29">
99 TarArchiveEntry provides access to the flags that determine
100 whether it is an archived symbolic link, pipe or other
101 "uncommon" file system object.
102 </action>
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +0000103 <action issue="COMPRESS-119" type="fix" date="2010-10-26">
Sebastian Bazley7dd43012010-10-28 14:15:27 +0000104 TarArchiveOutputStream#finish now writes all buffered data to the stream
Stefan Bodewig1eb9dbb2010-10-26 09:44:59 +0000105 </action>
106 </release>
107 <release version="1.1" date="2010-08-13" description="Release 1.1">
Sebastian Bazley75c87112010-06-02 11:15:23 +0000108 <action issue="COMPRESS-72" type="fix" date="2010-06-02">
109 Move acknowledgements from NOTICE to README
110 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +0000111 <action issue="COMPRESS-113" type="fix" date="2010-06-02">
112 TarArchiveEntry.parseTarHeader() includes the trailing space/NUL when parsing the octal size
113 </action>
114 <action issue="COMPRESS-108" type="add" date="2010-05-23">
Sebastian Bazleydfc66382010-05-23 11:53:07 +0000115 Command-line interface to list archive contents.
116 Usage: java -jar commons-compress-n.m.jar archive-name [zip|tar|etc]
117 </action>
Sebastian Bazley050db3d2010-05-17 15:09:29 +0000118 <action issue="COMPRESS-118" type="fix" date="2010-05-17">
119 TarUtils.parseName does not properly handle characters outside the range 0-127
120 </action>
Sebastian Bazleyc83d9f72010-05-13 10:25:15 +0000121 <action issue="COMPRESS-112" type="update" date="2010-05-13">
122 ArArchiveInputStream does not handle GNU extended filename records (//)
123 </action>
Sebastian Bazley35e4e4f2010-06-02 11:00:25 +0000124 <action issue="COMPRESS-109" type="add" date="2010-05-10">
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000125 Tar implementation does not support Pax headers
126 Added support for reading pax headers.
127 Note: does not support global pax headers
Sebastian Bazley27dea242010-05-10 17:42:37 +0000128 </action>
Sebastian Bazley23bfa662010-05-10 15:10:27 +0000129 <action issue="COMPRESS-107" type="fix" date="2010-05-10">
130 ArchiveStreamFactory does not recognise tar files created by Ant
Sebastian Bazley27dea242010-05-10 17:42:37 +0000131 </action>
Sebastian Bazley8fcd06e2010-05-09 20:46:59 +0000132 <action issue="COMPRESS-110" type="fix" date="2010-05-09">
133 Support "ustar" prefix field, which is used when file paths are longer
134 than 100 characters.
Sebastian Bazley27dea242010-05-10 17:42:37 +0000135 </action>
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000136 <action type="update" date="2010-04-19" issue="COMPRESS-105">
137 Document that the name of an ZipArchiveEntry determines whether
Sebastian Bazley27dea242010-05-10 17:42:37 +0000138 an entry is considered a directory or not.
Sebastian Bazley69f6d062010-05-05 10:59:58 +0000139 If you don't use the constructor with the File argument the entry's
140 name must end in a "/" in order for the entry to be known as a directory.
141 </action>
Stefan Bodewig03e94a42010-03-19 15:08:23 +0000142 <action type="add" date="2010-03-19" issue="COMPRESS-103">
143 ZipArchiveInputStream can optionally extract data that used
144 the STORED compression method and a data descriptor.
145 Doing so in a stream is not safe in general, so you have to
146 explicitly enable the feature. By default the stream will
147 throw an exception if it encounters such an entry.
148 </action>
Stefan Bodewig62cb9c42010-03-12 16:06:20 +0000149 <action type="fix" date="2010-03-12" issue="COMPRESS-100">
150 ZipArchiveInputStream will throw an exception if it detects an
151 entry that uses a data descriptor for a STORED entry since it
152 cannot reliably find the end of data for this "compression"
153 method.
154 </action>
Stefan Bodewigd7ea9ff2010-03-12 15:35:44 +0000155 <action type="fix" date="2010-03-12" issue="COMPRESS-101">
156 ZipArchiveInputStream should now properly read archives that
157 use data descriptors but without the "unofficial" signature.
158 </action>
Stefan Bodewig30e1cc82010-03-09 11:23:41 +0000159 <action type="add" date="2010-03-09" issue="COMPRESS-98">
160 The ZIP classes will throw specialized exceptions if any
161 attempt is made to read or write data that uses zip features
162 not supported (yet).
163 </action>
Stefan Bodewigade93792010-03-08 12:00:25 +0000164 <action type="add" date="2010-03-08" issue="COMPRESS-99">
165 ZipFile#getEntries returns entries in a predictable order -
166 the order they appear inside the central directory.
167 A new method getEntriesInPhysicalOrder returns entries in
168 order of the entry data, i.e. the order ZipArchiveInputStream
169 would see.
170 </action>
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000171 <action type="add" date="2010-02-19">
Stefan Bodewige0692ec2010-02-24 15:35:47 +0000172 The Archive*Stream and ZipFile classes now have
173 can(Read|Write)EntryData methods that can be used to check
174 whether a given entry's data can be read/written.
Stefan Bodewiga33505b2010-02-19 12:23:27 +0000175 The method currently returns false for ZIP archives if an
176 entry uses an unsupported compression method or encryption.
Stefan Bodewige0ffbc12010-02-19 10:59:01 +0000177 </action>
178 <action type="add" date="2010-02-19" issue="COMPRESS-89">
179 The ZIP classes now detect encrypted entries.
180 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000181 <action type="update" date="2010-02-18" issue="COMPRESS-79">
182 Move DOS/Java time conversions into Zip utility class.
183 </action>
Stefan Bodewiga1015f32010-02-18 16:11:13 +0000184 <action type="fix" date="2010-02-18" issue="COMPRESS-74">
185 ZipArchiveInputStream failed to update the number of bytes
186 read properly.
187 </action>
188 <action type="fix" date="2010-02-18">
189 ArchiveInputStream has a new method getBytesRead that should
190 be preferred over getCount since the later may truncate the
191 number of bytes read for big archives.
192 </action>
Stefan Bodewig315b9472010-02-18 14:56:03 +0000193 <action type="fix" date="2010-02-18" issue="COMPRESS-85">
194 The cpio archives created by CpioArchiveOutputStream couldn't
195 be read by many existing native implementations because the
196 archives contained multiple entries with the same inode/device
197 combinations and weren't padded to a blocksize of 512 bytes.
198 </action>
Stefan Bodewig91695e42010-02-16 13:59:03 +0000199 <action type="fix" date="2010-02-16" issue="COMPRESS-73">
200 ZipArchiveEntry, ZipFile and ZipArchiveInputStream are now
201 more lenient when parsing extra fields.
202 </action>
Sebastian Bazley78e0f2c2010-06-01 16:38:13 +0000203 <action issue="COMPRESS-75" type="update" date="2010-02-12">
204 ZipArchiveInputStream does not show location in file where a problem occurred.
205 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000206 <action type="fix" date="2010-02-12" issue="COMPRESS-82">
207 cpio is terribly slow.
208 Documented that buffered streams are needed for performance
209 </action>
Stefan Bodewig292e1852010-03-04 15:54:09 +0000210 <action type="add" date="2010-02-12" issue="COMPRESS-97">
211 Added autodetection of compression format to
212 CompressorStreamFactory.
213 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000214 <action type="fix" date="2010-02-12">
215 Improved exception message if the extra field data in ZIP
216 archives cannot be parsed.
217 </action>
Sebastian Bazley886f71b2010-04-13 21:21:03 +0000218 <action type="fix" date="2010-02-11" issue="COMPRESS-17">
219 Tar format unspecified - current support documented.
220 </action>
Stefan Bodewig124f97c2010-02-12 11:35:14 +0000221 <action type="add" issue="COMPRESS-95" date="2010-01-29"
Christian Grobmeiere7517b82010-01-29 07:47:21 +0000222 due-to="Joerg Bellmann">
223 Improve ExceptionMessages in ArchiveStreamFactory
224 </action>
Stefan Bodewig5066e9a2010-01-07 09:34:55 +0000225 <action type="fix" issue="COMPRESS-94" date="2010-01-07"
226 due-to="Anon Devs">
227 ZipArchiveEntry's equals method was broken for entries created
228 with the String-arg constructor. This lead to broken ZIP
229 archives if two different entries had the same hash code.
230 </action>
Stefan Bodewigdc3fc472009-10-30 05:29:17 +0000231 <action type="fix" issue="COMPRESS-87" date="2009-10-30"
232 due-to="Antoni Mylka">
233 ZipArchiveInputStream could repeatedly return 0 on read() when
234 the archive was truncated.
235 </action>
Stefan Bodewig7bb5d882009-10-08 12:07:19 +0000236 <action type="fix" issue="COMPRESS-86" date="2009-10-08">
237 Tar archive entries holding the file name for names longer
238 than 100 characters in GNU longfile mode didn't properly
239 specify they'd be using the "oldgnu" extension.
240 </action>
Stefan Bodewig3e2ddad2009-08-25 08:11:44 +0000241 <action type="add" date="2009-08-25">
242 A new constructor of TarArchiveEntry can create entries with
243 names that start with slashes - the default is to strip
244 leading slashes in order to create relative path names.
245 </action>
Stefan Bodewig7be8ef62009-08-01 20:25:13 +0000246 <action issue="COMPRESS-83" type="fix" date="2009-08-01">
247 Delegate all read and write methods in GZip stream in order to
248 speed up operations.
249 </action>
250 <action type="add" date="2009-08-01">
251 ArchiveEntry now has a getLastModifiedDate method.
252 </action>
253 <action type="fix" date="2009-08-01">
254 The ar and cpio streams now properly read and write last
255 modified times.
256 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000257 <action issue="COMPRESS-81" type="fix" date="2009-06-30">
258 TarOutputStream can leave garbage at the end of the archive
259 </action>
Stefan Bodewig47b706e2009-06-30 08:23:08 +0000260 <action issue="COMPRESS-78" type="add" date="2009-06-30"
261 due-to="Jukka Zitting">
262 Add a BZip2Utils class modelled after GZipUtils
263 </action>
Stefan Bodewig2318ba32009-06-30 07:25:44 +0000264 </release>
265 <release version="1.0" date="2009-05-21" description="First Public Release">
266 <action dev="all" type="add" date="2009-05-21">
Christian Grobmeier35ac05e2009-05-10 17:32:20 +0000267 Initial release
268 </action>
Siegfried Goeschlf03f2f92009-03-23 14:52:23 +0000269 <action dev="sgoeschl" type="fix">
270 Updating the pom.xml for preparing a move to commons-proper
271 </action>
272 </release>
273 </body>
274</document>