forked from apache/commons-compress
-
Notifications
You must be signed in to change notification settings - Fork 1
/
RELEASE-NOTES.txt
1723 lines (1575 loc) · 72.4 KB
/
RELEASE-NOTES.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Apache Commons Compress RELEASE NOTES
Apache Commons Compress defines an API for working with
compression and archive formats. These include: bzip2, gzip, pack200,
lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4,
Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.
New features:
o Use FileTime for time fields in SevenZipArchiveEntry #256.
Issue: COMPRESS-614. Thanks to Andre Brait, Gary Gregory.
o Fix calculation the offset of the first ZIP central directory entry #334.
Issue: COMPRESS-621. Thanks to Glavo.
o Add encryption support for SevenZ #332.
Issue: COMPRESS-633. Thanks to Daniel Santos, Bruno P. Kinoshita, Gary Gregory.
o Support for extra time data in Zip archives #345.
Issue: COMPRESS-613. Thanks to Andre Brait, Gary Gregory, Bruno P. Kinoshita.
o Add org.apache.commons.compress.archivers.zip.DefaultBackingStoreSupplier to write to a custom folder instead of the default temporary folder.
Issue: COMPRESS-621. Thanks to Gary Gregory.
o Add capability to configure Deflater strategy in GzipCompressorOutputStream: GzipParameters.setDeflateStrategy(int).
Issue: COMPRESS-600. Thanks to Gary Gregory, Pascal Davoust.
Fixed Bugs:
o Implicit narrowing conversion in compound assignment. Thanks to CodeQL, Gary Gregory.
o Avoid NPE in FileNameUtils.getBaseName(Path) for paths with zero elements like root paths. Thanks to CodeQL, Gary Gregory.
o Avoid NPE in FileNameUtils.getExtension(Path) for paths with zero elements like root paths. Thanks to CodeQL, Gary Gregory.
o LZMA2Decoder.decode() looses original exception. Thanks to Gary Gregory.
o Extract conditions and avoid duplicate code. #297. Thanks to Arturo Bernal.
o Remove duplicate conditions. Use switch instead. #298. Thanks to Arturo Bernal.
o Replace JUnit 3 and 4 with JUnit 5 #344, #346. Thanks to Robin Schimpf.
o Make 'ZipFile.offsetComparator' static #353. Thanks to Glavo.
o The GzipCompressorOutputStream#writeHeader() uses ISO_8859_1 to write the file name and comment.
If the strings contains non-ISO_8859_1 characters, unknown characters are displayed after decompression.
Use percent encoding for non ISO_8859_1 characters.
Issue: COMPRESS-638. Thanks to Radar wen, Gary Gregory, Michael Osipov.
o Port some code from IO to NIO APIs. Thanks to Jonathan Leitschuh, Gary Gregory.
o pack200: Fix FileBands misusing InputStream#read(byte[]) #360. Thanks to Una, Gary Gregory, Jochen Wiedmann, quaternary, Bruno P. Kinoshita.
o Add TarArchiveEntry.getLinkFlag() #365.
Issue: COMPRESS-641. Thanks to XenoAmess, Gary Gregory, Bruno P. Kinoshita.
o Integer overflow ArithmeticException in TarArchiveOutputStream #368.
Issue: COMPRESS-642. Thanks to Anton Klarén, Gary Gregory.
o org.apache.commons.compress.archivers.zip.ZipFile.finalize() should not write to std err.
Issue: COMPRESS-642. Thanks to Dominik Stadler, Stefan Bodewig, Gary Gregory.
Changes:
o Bump mockito.version from 4.8.0 to 4.11.0 #328, #331, #340, #348. Thanks to Dependabot.
o Bump pmd from 6.50.0 to 6.53.0. Thanks to Gary Gregory.
o Bump memoryfilesystem from 2.3.0 to 2.5.0 #330, #359. Thanks to Dependabot.
o Bump slf4j-api from 2.0.3 to 2.0.7 #329, #333, #341, #371. Thanks to Dependabot.
o Bump japicmp from 0.16.0 to 0.17.1. Thanks to Gary Gregory.
o Bump commons-parent from 54 to 56 #339, #349. Thanks to Dependabot.
o Bump zstd-jni from 1.5.2-5 to 1.5.4-2 #362, #364. Thanks to Dependabot.
Removed:
o Remove BZip2CompressorOutputStream.finalize() which only wrote to std err. Thanks to Gary Gregory.
For complete information on Apache Commons Compress, including instructions
on how to submit bug reports, patches, or suggestions for improvement,
see the Apache Commons Compress website:
https://commons.apache.org/compress/
Download it from https://commons.apache.org/compress/download_compress.cgi
Old Release Notes
=================
Release 1.22
------------
New features:
o Migrate zip package to use NIO #236.
Issue: COMPRESS-602. Thanks to Postelnicu George, Gary Gregory.
o Add APK file extension constants: ArchiveStreamFactory.APK, APKM, APKS, XAPK. Thanks to Gary Gregory.
o ArchiveStreamFactory.createArchiveInputStream(String, InputStream, String) supports the "APK" format (it's a JAR). Thanks to Gary Gregory.
o Expander example now has NIO Path versions of IO File APIs. Thanks to Gary Gregory.
o Improve TAR support for file times #254.
Issue: COMPRESS-612. Thanks to Andre Brait, Gary Gregory.
o Add SevenZArchiveEntry.setContentMethods(SevenZMethodConfiguration...). Thanks to Gary Gregory.
Fixed Bugs:
o Fix some compiler warnings in pack200 packages. Thanks to Gary Gregory.
o Close File input stream after unpacking in Pack200UnpackerAdapter.unpack(File, JarOutputStream). Thanks to Gary Gregory.
o Pack200UnpackerAdapter.unpack(InputStream, JarOutputStream) should not close its given input stream. Thanks to Gary Gregory.
o Fix minor problem in examples.
Issue: COMPRESS-596. Thanks to Tamas Mucs.
o Add a limit to the copy buffer in IOUtils.readRange() to
avoid reading more from a channel than asked for.
Github Pull Request #214.
Issue: COMPRESS-584. Thanks to Matthijs Laan, Peter Lee.
o Documentation nits #217. Thanks to Helder Magalhães, Gary Gregory, PeterAlfredLee.
o Replace wrapper Collections.sort is with an instance method directly. #245. Thanks to Arturo Bernal.
o Replace manual comparisons with Comparator.comparingInt() #244. Thanks to Arturo Bernal.
o Replace manual copy of array contents with System.arraycopy() #246. Thanks to Arturo Bernal.
o Fix thread safety issues when encoding 7z password #248. Thanks to Glavo, Bruno P. Kinoshita, PeterAlfredLee, Gary Gregory.
o bzip2: calculate median-of-3 on unsigned values #242. Thanks to Peter Dettman.
o Use Math.min and Math.max calculations. #247. Thanks to Arturo Bernal, Gary Gregory, Bruno P. Kinoshita.
o Expander should be able to work if an entry's name is "./".
Issue: COMPRESS-603. Thanks to Matt Sicker.
o Ensure compatibility with Java 8 #252.
Issue: COMPRESS-604. Thanks to Andre Brait.
o Use StringBuilder instead of StringBuffer. #284. Thanks to Arturo Bernal.
o Inline variable. Remove redundant local variable. #283. Thanks to Arturo Bernal.
o Use compare method #285. Thanks to Arturo Bernal.
o Remove Unnecessary interface modifiers #281. Thanks to Arturo Bernal.
o Avoid use C-style array declaration. #282. Thanks to Arturo Bernal.
o ChecksumVerifyingInputStream.read() does not always validate checksum at end-of-stream. Thanks to Gary Gregory.
o Fix TarFileTest #289. Thanks to Matt Juntunen.
o Update Wikipedia link in TarUtils.java:627.
Issue: COMPRESS-625. Thanks to MrBump, Gary Gregory.
o OutOfMemoryError on malformed pack200 input (attributes).
Issue: COMPRESS-626. Thanks to Andrii Hudz, Gary Gregory.
o OutOfMemoryError on malformed pack200 input (org.apache.commons.compress.harmony.pack200.NewAttributeBands.readNextUnionCase).
Issue: COMPRESS-628. Thanks to Andrii Hudz, Gary Gregory.
o OutOfMemoryError on malformed unpack200 input (org.apache.commons.compress.harmony.unpack200.NewAttributeBands.readNextUnionCase).
Issue: COMPRESS-628. Thanks to Gary Gregory.
o Some input streams are not closed in org.apache.commons.compress.harmony.pack200.PackingUtils. Thanks to Gary Gregory.
o Pack200 causes a 'archive.3E' error if it?s not in the system class loader.
Issue: COMPRESS-627. Thanks to anatawa12, Gary Gregory.
Changes:
o Bump actions/cache from 2.1.6 to 3.0.10 #230, #257, #305, #320. Thanks to Dependabot, Gary Gregory.
o Bump actions/checkout from 2.3.4 to 3.1.0 #226, #227, #251, #300, #321. Thanks to Dependabot, Gary Gregory.
o Bump actions/setup-java from 2 to 3.5.1 #278. Thanks to Dependabot.
o Bump github/codeql-action from 1 to 2 #287. Thanks to Dependabot.
o Bump mockito-core from 3.11.1 to 4.6.1 #209, #224, #231, #235, #243, #253, #286, #294. Thanks to Dependabot.
o Bump org.apache.felix.framework from 7.0.0 to 7.0.1 #208. Thanks to Dependabot.
o Bump memoryfilesystem from 2.1.0 to 2.3.0 #212, #237. Thanks to Dependabot.
o Bump zstd-jni from 1.5.0-2 to 1.5.2-5 #215, #233, #238, #240, #250, #291, #326. Thanks to Dependabot, Gary Gregory.
o Bump Pack200 packages from ASM 3.2 to 9.2 #216.
Breaks binary compatibility in the internals of the pack200 implementation:
- org.apache.commons.compress.harmony.pack200.Segment
- org.apache.commons.compress.harmony.pack200.SegmentMethodVisitor
- org.apache.commons.compress.harmony.pack200.SegmentAnnotationVisitor
- org.apache.commons.compress.harmony.pack200.SegmentFieldVisitor
Issue: COMPRESS-582. Thanks to Alex Landau, Stephan, Gary Gregory.
o Bump asm from 9.2 to 9.4 #279, #322. Thanks to Dependabot.
o Bump maven-javadoc-plugin from 3.3.0 to 3.4.1 #221, #249, #288, #308. Thanks to Dependabot.
o Bump maven-pmd-plugin from 3.14.0 to 3.19.0 #296, #309, #311. Thanks to Gary Gregory, Dependabot.
o Bump pmd from 6.44.0 to 6.50.0. Thanks to Gary Gregory.
o Bump commons.japicmp.version from 0.15.3 to 0.16.0. Thanks to Gary Gregory.
o Bump maven-bundle-plugin from 5.1.2 to 5.1.8 #234, #239, #290, #292, #301, #304. Thanks to Dependabot.
o Bump org.apache.felix.framework from 7.0.1 to 7.0.5 #232, #295. Thanks to Dependabot.
o Bump slf4j-api from 1.7.30 to 2.0.3 #213, #241, #258, #310, #314, #315, #318. Thanks to Dependabot.
o Bump commons-parent from 52 to 54 #280. Thanks to Dependabot, Gary Gregory.
o Bump commons.jacoco.version from 0.8.7 to 0.8.8. Thanks to Gary Gregory.
o Bump junit.version from 5.8.2 to 5.9.1 #302, #317. Thanks to Dependabot.
o Bump mockito.version from 4.6.1 to 4.8.0 #307, #312. Thanks to Dependabot.
o Bump maven-surefire-plugin from 3.0.0-M6 to 3.0.0-M7. Thanks to Gary Gregory.
For complete information on Apache Commons Compress, including instructions
on how to submit bug reports, patches, or suggestions for improvement,
see the Apache Commons Compress website:
https://commons.apache.org/compress/
Release 1.21
------------
Compress 1.21 is the first release to require Java 8 to build and run.
SevenZFileOptions has a new setting that needs to be enabled
explicitly if SevenZFile should try to recover broken archives - a
feature introduced with Commons Compress 1.19. This is a breaking
change if you relied on the recovery attempt. The change was made to
detect broken archives sooner, and to mitigate the OOM exploit.
Several formats now throw IOExceptions when reading broken archives or
streams that would have caused arbitrary RuntimeExceptions in earlier
versions of Compress.
New features:
o Add writePreamble to ZipArchiveInputStream. This method could
write raw data to zip archive before any entry was written to
the zip archive.
For most of the time, this is used to create self-extracting
zip.
Github Pull Request #127.
Issue: COMPRESS-550.
Thanks to Scott Frederick.
o Added support for random access to the TAR packages.
Github Pull Request #113.
Issue: COMPRESS-540.
Thanks to Robin Schimpf.
o Added support for BufferPool in ZstdCompressorInputStream.
Github Pull Request #165.
Issue: COMPRESS-565.
Thanks to Michael L Heuer.
o Commons Compress cannot be built with JDK14 due to Pack200 removal.
Add Pack200 implementation from Apache Harmony.
Issue: COMPRESS-507.
Thanks to Gary Gregory, Apache Harmony.
o Add a new AlwaysWithCompatibility in Zip64Mode, this is a
compromise for some libraries including 7z and Expand-Archive
Powershell utility(and likely Excel).
And we will encode both the LFH offset and Disk Number Start
in the ZIP64 Extended Information Extra Field - even if only
the disk number needs to be encoded.
Github Pull Request #169.
Issue: COMPRESS-565.
Thanks to Evgenii Bovykin.
o gzip deflate buffer size is now configurable.
Issue: COMPRESS-566.
Thanks to Brett Okken.
Fixed Bugs:
o Fix bugs in random access of 7z. Problems may happen
in a mixture use of random access and sequential access
of 7z.
Github Pull Request #95.
Issue: COMPRESS-505.
o Fix bugs in random access of 7z. Exceptions are thrown
when reading the first entry multiple times by random
access.
Issue: COMPRESS-510.
o Add '/' to directories with long name in tar. This is to
resolve the ambiguous behavior of the TarArchiveEntry.getName()
method between directory with short name and long name.
Issue: COMPRESS-509.
Thanks to Petr Vasak.
o Removed the PowerMock dependency.
Issue: COMPRESS-520.
Thanks to Robin Schimpf.
o Added improved checks to detect corrupted bzip2 streams and
throw the expected IOException rather than obscure
RuntimeExceptions.
See also COMPRESS-519.
Issue: COMPRESS-516.
o Improved parsing of X5455_ExtendedTimestamp ZIP extra field.
Issue: COMPRESS-517.
o ZipArchiveInputStream and ZipFile will now throw an
IOException rather than a RuntimeException if the zip64 extra
field of an entry could not be parsed.
Issue: COMPRESS-518.
o Improved detection of corrupt ZIP archives in ZipArchiveInputStream.
Issue: COMPRESS-523.
o Added improved checks to detect corrupted deflate64 streams and
throw the expected IOException rather than obscure
RuntimeExceptions.
Issues: COMPRESS-521, COMPRESS-522, COMPRESS-525, COMPRESS-526, and COMPRESS-527.
o Add the archive name in the exception in the constructor of
ZipFile to make it a more specific exception.
Github Pull Request #102.
Issue: COMPRESS-515.
Thanks to ian-lavallee.
o Throw IOException when it encounters a non-number while parsing pax
header.
Issue: COMPRESS-530.
o Throw IOException when a tar archive contains a PAX header
without any normal entry following it.
Issue: COMPRESS-531.
o Added improved checks to detect corrupted IMPLODED streams and
throw the expected IOException rather than obscure
RuntimeExceptions.
Issue: COMPRESS-532.
o Throw expected IOException instead of NumberFormatException if
it encounters non-numbers when parsing pax headers for tarball.
Throw IllegalArgumentException instead of RuntimeExceptions if
the file name is longer than 100 bytes with the longFileMode
of LONGFILE_ERROR, and address this in java docs.
Throw IllegalArgumentException instead of RuntimeExceptions if
the any of the numeric values of an entry exceeds the limits
of a traditional tar header while bigNumberMode is
BIGNUMBER_ERROR, and address this in java docs.
Issue: COMPRESS-529.
o Fix for test fails on Windows. The tests are failing because the
default charset is not UTF-8.
Issue: COMPRESS-543.
Thanks to wulf2333.
o TarArchiveInputStream can not detect a truncated tar in skip()
and skipRecordPadding().
Issue: COMPRESS-544.
Thanks to Aditya Prasad.
o Make the memory allocation in SevenZFile.readFilesInfo a lazy
allocation to avoid OOM when dealing some giant 7z archives.
Github Pull Request #120.
Also added sanity checks before even trying to parse an
archive and made SevenZFileOptions' maxMemorySizeInKb apply to
the stored metadata for an archive.
And further added an option that needs to be enabled in order
to make SevenZFile try to recover a broken archive. This is a
backwards incompatible change.
Issue: COMPRESS-542.
Thanks to theobisproject.
o ZipArchiveInputStream should throw an exception if a corrputed
zip64 extra field is met.
Issue: COMPRESS-546.
Thanks to Maksim Zuev.
o Add a new maven profile in pom.xml for JDK14+ to ignore the
failing tests about Pack200.
This has later been superseeded by adding the Apache Harmony
classes for Pack200 support.
o Throw an IOException when reading the zip extra field if the
length is too short.
Issue: COMPRESS-548.
Thanks to Maksim Zuev.
o Throw an declared IOException if a null entry is met when
reading a global pax header instead of a runtime NPE.
Issue: COMPRESS-554.
Thanks to Maksim Zuev.
o ZIP extraction could lead to ArrayIndexOutOfBoundsExceptions
rather than the expected IOException.
Issue: COMPRESS-545.
Thanks to Maksim Zuev.
o Add asserts for Arrays.copyOf in X0017_StrongEncryptionHeader.
Issue: COMPRESS-547.
Thanks to Maksim Zuev.
o Fix for the CFH signature detect in ZipArchiveInputStream.
The problem could be reproduced by a zip archive with Data
Descriptor and STORED, and without the Data Descriptor
signature.
o The length validation in TarArchiveInputStream.parsePaxHeaders
should also consider the headers with length smaller than 1
and ignore these headers.
Issue: COMPRESS-553.
Thanks to Maksim Zuev.
o Fix accidentally added '/' to file names.
This problem is caused by the incomplete fix of COMPRESS-509.
Github Pull Request #151.
Issue: COMPRESS-558.
Thanks to Robin Schimpf.
o As sparse entries can be successfully parsed now,
TarArchiveInputStream.canReadEntryData should return
true if the entry is a sparse entry.
Github Pull Request #153.
Issue: COMPRESS-560.
Thanks to Robin Schimpf.
o SparseFilesTest#testExtractPaxGNU should be skipped
if the version of GNU tar binary is 1.28.
Github Pull Request #152.
Issue: COMPRESS-559.
Thanks to Robin Schimpf.
o Removed an empty loop that was just warming the planet for
certain ZIP archives.
Github Pull Request #172.
Thanks to Fabian Meumertzheim.
o Made some of the stream classes used internally throw
IOExceptions on illegal arguments rather than
RuntimeExceptions to make it more likely that corrupt archives
cause expected checked exceptions rather than RuntimException
for various formats.
Fixes a specific case for ZIP but affects other formats as
well.
Issue: COMPRESS-567.
o Simplify Assertions #205.
Thanks to Arturo Bernal.
o Checked the sizes read for archive entries and reject archives
as broken with negative entry sizes.
Fixes an infinite loop in the new TarFile class but affects
several formats.
Issue: COMPRESS-569.
o OSGi detection was broken and so we always cached whether
xz/brotli/zstd/lzma have been available even in OSGi
environments.
Issue: COMPRESS-552.
o SevenZFile.getEntries now return a copy of entries.
Issue: COMPRESS-571.
o Handling of sparse tar entries has been hardened to ensure bad
inputs cause expected IOExceptions rather than RuntimeExceptions.
Issue: COMPRESS-575.
o The parser for GNU sparse tar headers could throw a
NullPointerExcpetion rather than an IOException if the archive
ended while more sparse headers were expected.
Changes:
o Made sure ZstdCompressorOutputStream no longer used
deprecated ZstOutputStream constructors.
Github Pull Request #94.
Thanks to Peter Alfred Lee.
o Make compression level of ParallelScatterZipCreator
configurable via a new constructor.
Issue: COMPRESS-504.
o Made an inner class static
Github Pull Request #107.
Issue: COMPRESS-536.
Thanks to Jin Xu.
o added an early exit to a loop in BZip2CompressorOutputStream
Github Pull Request #106.
Issue: COMPRESS-535.
Thanks to Jin Xu.
o Update the class of variable file in TarArchiveEntry from
java.io.File to java.nio.file.Path. Corresponding constructors
and methods are also modified/added.
NOTE: The userName, groupName, userID and groupID will also be
set if they are available. The userName and groupName was not
set previously, and the previous value of UserID:GroupID was
0:0 by default.
Please note this may cause a reproducibility problem.
Github Pull Request #97.
Issue: COMPRESS-404.
Thanks to theobisproject.
o Reuse the record buffer in TarArchiveInputStream.
Issue: COMPRESS-539.
Thanks to Robin Schimpf.
o Add SevenZOutputFile.write(InputStream).
Thanks to Gary Gregory.
o Add SevenZOutputFile.write(Path, OpenOption...).
Thanks to Gary Gregory.
o Add SevenZOutputFile.createArchiveEntry(Path, String, LinkOption...).
Thanks to Gary Gregory.
o Add ArArchiveOutputStream.createArchiveEntry(Path, String, LinkOption...).
Thanks to Gary Gregory.
o Add ArArchiveEntry(Path, String, LinkOption...).
Thanks to Gary Gregory.
o Add ctor CpioArchiveEntry(Path, String, LinkOption...).
Thanks to Gary Gregory.
o Add ctor CpioArchiveEntry(short, Path, String, LinkOption...).
Thanks to Gary Gregory.
o Add CpioArchiveEntry.setTime(FileTime).
Thanks to Gary Gregory.
o Add TarArchiveOutputStream.createArchiveEntry(Path, String, LinkOption...).
Thanks to Gary Gregory.
o Add ctor TarArchiveEntry(Path, String, LinkOption...).
Thanks to Gary Gregory.
o Add IOUtils.EMPTY_LINK_OPTIONS.
Thanks to Gary Gregory.
o Add Path support to ZipArchiveOutputStream #123.
Thanks to Gary Gregory.
o Some minor improvements.
Github Pull Request #157.
Issue: COMPRESS-561.
Thanks to Arturo Bernal.
o Update from Java 7 to 8.
o Update GitHub actions/checkout from v1 to v2.3.4, #114, #124, #139, #150.
Thanks to Dependabot.
o Update actions/setup-java from v1.4.0 to v2, #125, #133, #141.
Thanks to Dependabot, Gary Gregory.
o Update com.github.luben:zstd-jni from 1.4.4-7 to 1.5.0-2, #118, #159, #173, #174, #203.
Thanks to Dependabot, Gary Gregory.
o Update tests slf4j-api from 1.7.26 to 1.7.30 #117.
Thanks to Dependabot.
o Update maven-pmd-plugin from 3.12.0 to 3.14.0, #115, #154.
Thanks to Dependabot.
o Update maven-bundle-plugin from 3.5.1 to 5.1.2 #116, #180.
Thanks to Dependabot.
o Bump memoryfilesystem from 1.3.0 to 2.1.0 #131.
Thanks to Dependabot.
o Bump actions/cache from v2 to v2.1.6, #164, #200.
Thanks to Dependabot.
o Bump junit from 4.13 to 4.13.2, #143, #167.
Thanks to Dependabot.
o Bump mockito-core from 1.10.19 to 3.11.1, #161, #170, #204.
Thanks to Dependabot.
o Bump commons.jacoco.version from 0.8.5 to 0.8.7 (Java 16 builds).
Thanks to Gary Gregory.
o Bump org.apache.felix:org.apache.felix.framework from 6.0.3 to 7.0.0 (Java 16 builds).
Thanks to Gary Gregory.
o Bump commons.japicmp.version from 0.14.3 to 0.15.3 (Java 16 builds).
Thanks to Gary Gregory.
o Bump commons.javadoc.version from 3.2.0 to 3.3.0.
Thanks to Gary Gregory.
o Update com.github.luben:zstd-jni from 1.4.8-7 to 1.4.9-1 #176.
Thanks to Dependabot.
o Update org.tukaani:xz from 1.8 to 1.9
o Some minor improvements.
Github Pull Request #193.
Issue: COMPRESS-577.
Thanks to Arturo Bernal.
o Java8 improvements.
Github Pull Request #194.
Issue: COMPRESS-578.
Thanks to Arturo Bernal.
o Remove redundant local variable.
Github Pull Request #195.
Issue: COMPRESS-579.
Thanks to Arturo Bernal.
o Remove redundant operation
Github Pull Request #196.
Issue: COMPRESS-580.
Thanks to Arturo Bernal.
Release 1.20
------------
Commons Compress 1.20 like any version of Commons Compress since 1.3
can not be built from sources using Java 14 as Java 14 removes
support for the Pack200 format. We will address this issue with the
next release.
Fixed Bugs:
o SevenZFile could throw NullPointerException rather than
IOException for certain archives. In addition it now handles
certain empty archives more gracefully.
Issue: COMPRESS-492.
o Deflate64CompressorInputStream.read would return 0 for some
inputs in violation of the InputStream.read contract.
Issue: COMPRESS-491.
o SeekableInMemoryByteChannel's truncate didn't set position
according to the spec in an edge case.
Issue: COMPRESS-499.
o BZip2CompressorInputStream now incorporates a similar patch as
the one that fixed CVE-2019-12900 in libbzip2.
Commons Compress has not been vulnerable to this CVE as it
would have rejected a file with too many selectors. With this
patch Commons Compress will be able to read certain archives
that would have caused errors in Compress 1.19. Thanks to Joseph Allemandou.
Changes:
o Update optional library com.github.luben:zstd-jni from
1.4.0-1 to 1.4.4-7.
Issue: COMPRESS-493.
o Update tests from org.apache.felix:org.apache.felix.framework
6.0.2 to 6.0.3.
o SevenZFile can now recover from a certain corruption that
seems to happen occasionally when split archives are created.
Issue: COMPRESS-497.
Thanks to Stefan Schlott.
o Added random access support to SevenZFile.
Issue: COMPRESS-342.
Thanks to Peter Alfred Lee.
o Added support for split ZIP archives.
Issue: COMPRESS-477.
Thanks to Peter Alfred Lee.
o Added support for reading sparse entries to the TAR package.
Issue: COMPRESS-124.
Thanks to Peter Alfred Lee.
o Update JUnit from 4.12 to 4.13.
Removed:
o Removed the extraction code from the example CLI class inside
of the SevenZ package. Not only is it superseeded by the
examples package, its implementation was vulnerable to the
ZipSlip attack.
Issue: COMPRESS-495.
Release 1.19
------------
ZipArchiveInputStream and ZipFile will no longer throw an exception if
an extra field generally understood by Commons Compress is malformed
but rather turn them into UnrecognizedExtraField instances. You can
influence the way extra fields are parsed in more detail by using the
new getExtraFields(ExtraFieldParsingBehavior) method of
ZipArchiveEntry now.
Some of the ZIP extra fields related to strong encryption will now
throw ZipExceptions rather than ArrayIndexOutOfBoundsExceptions in
certain cases when used directly. There is no practical difference
when they are read via ZipArchiveInputStream or ZipFile.
New features:
o It is now possible to skip parsing of local file headers when
using ZipFile which may speed up reading the archive at the
cost of potentially missing important information. See the
javadocs of the ZipFile class for details.
Issue: COMPRESS-466.
o TarArchiveInputStream has a new constructor-arg lenient that
can be used to accept certain broken archives.
Issue: COMPRESS-469.
o ArjArchiveEntry and SevenZArchiveEntry now implement hashCode
and equals.
Issue: COMPRESS-475.
o Added a MultiReadOnlySeekableByteChannel class
that can be used to concatenate the parts of a multi volume 7z
archive so that SevenZFile can read them.
Issue: COMPRESS-231.
Thanks to Tim Underwood.
Fixed Bugs:
o ZipArchiveInputStream could forget the compression level has
changed under certain circumstances.
o Fixed another potential resource leak in
ParallelScatterZipCreator#writeTo.
Issue: COMPRESS-470.
o ArArchiveInputStream could think it had hit EOF prematurely.
Github Pull Request #74.
Thanks to Alex Bertram.
o Throw IOException rather than RuntimeExceptions for certain
malformed LZ4 or Snappy inputs.
Issue: COMPRESS-490.
o ZipArchiveInputStream failed to read stored entries with a
data descriptor if the data descriptor didn't use the
signature invented by InfoZIP.
Issue: COMPRESS-482.
Changes:
o SevenZFile now provides a way to cap memory consumption for
LZMA(2) compressed content.
Github Pull Request #76.
Issue: COMPRESS-481.
Thanks to Robin Schimpf.
o The ARJ package has been updated to contain constants for more
recent specifications.
Issue: COMPRESS-464.
Thanks to Rostislav Krasny.
o Update optional library zstd-jni from 1.3.3-3 to 1.4.0-1.
Issue: COMPRESS-484.
o ParallelScatterZipCreator now writes the entries to the
gathered output in the same order they have been added.
Github Pull Requests #78 and #79.
Issue: COMPRESS-485.
Thanks to Hervé Boutemy, Tibor Digana.
o The Expander and Archive example classes can leak resources
they have wrapped around passed in streams or channels. The
methods consuming streams and channels have been adapted to
give the calling code a chance to deal with those wrapper
resources.
Issue: COMPRESS-486.
o ZipArchiveInputStream and ZipFile no longer assume Commons
Compress would understand extra fields better than the writer
of the archive and silently turn extra fields that Commons
Compress should understand into UnrecognizedExtraFields if
parsing said fields fails.
It is now possible to take more control over the extra field
parsing process with a new overload of
ZipArchiveEntry#getExtraFields.
Issue: COMPRESS-479.
o ZipArchiveInputStream will now throw an exception if reading a
stored entry with a data descriptor and the data descriptor
doesn't match what it has actually read.
The most common case for a situation like this is a stored ZIP
archive inside of the archive ZipArchiveInputStream currently
reads. In such a case ZipArchiveInputStream would happily
extract the contained archive and stop once the central
directory of the inner archive has been hit. This is a case
where ZipArchiveInputStream simply can not be used and only
ZipFile is able to read the archive.
The only other explanation is a broken archive. So the
exception prevents users from thinking they had successfully
read the contents of the archive.
Issue: COMPRESS-483.
o The 7zip tools provide a default name for archive entries
without name; SevenZFile returns a null name for such
entries. A new method getDefaultName has been added to derive
the same name the 7zip tools would use and an option has been
added that sets SevenZArchiveEntry's name to the default name
if it is not contained inside the archive.
Issue: COMPRESS-478.
Release 1.18
------------
This release changes the OSGi Manifest entry Bundle-SymbolicName from
org.apache.commons.compress to org.apache.commons.commons-compress.
New features:
o It is now possible to specify the arguments of zstd-jni's
ZstdOutputStream constructors via Commons Compress as well.
Issue: COMPRESS-460.
Thanks to Carmi Grushko.
Fixed Bugs:
o The example Expander class has been vulnerable to a path
traversal in the edge case that happens when the target
directory has a sibling directory and the name of the target
directory is a prefix of the sibling directory's name.
Thanks to Didier Loiseau.
o Changed the OSGi Import-Package to also optionally import
javax.crypto so encrypted archives can be read.
Issue: COMPRESS-456.
o Changed various implementations of the close method to better
ensure all held resources get closed even if exceptions are
thrown during the closing the stream.
Issue: COMPRESS-457.
o ZipArchiveInputStream can now detect the APK Signing Block
used in signed Android APK files and treats it as an "end of
archive" marker.
Issue: COMPRESS-455.
o The cpio streams didn't handle archives using a multi-byte
encoding properly.
Issue: COMPRESS-459.
Thanks to Jens Reimann.
o ZipArchiveInputStream#read would silently return -1 on a
corrupted stored entry and even return > 0 after hitting the
end of the archive.
Issue: COMPRESS-463.
o ArArchiveInputStream#read would allow to read from the stream
without opening an entry at all.
Issue: COMPRESS-462.
Release 1.17
------------
New features:
o Added a unit test that is supposed to fail if we break the
OSGi manifest entries again.
Issue: COMPRESS-443.
o Add a new SkipShieldingInputStream class that can be used with
streams that throw an IOException when skip is invoked.
Issue: COMPRESS-449.
o New constructors have been added to SevenZFile that accept
char[]s rather than byte[]s in order to avoid a common error
of using the wrong encoding when creating the byte[]. This
change may break source compatibility for client code that
uses one of the constructors expecting a password and passes
in null as password. We recommend to change the code to use a
constructor without password argument.
Issue: COMPRESS-452.
Fixed Bugs:
o Removed the objenesis dependency from the pom as it is not
needed at all.
o Fixed resource leak in ParallelScatterZipCreator#writeTo.
Issue: COMPRESS-446.
o Certain errors when parsing ZIP extra fields in corrupt
archives are now turned into ZipException, they used to
manifest as ArrayIndexOutOfBoundsException before.
Issue: COMPRESS-447.
o IOUtils.copy now verifies the buffer size is bigger than 0.
Issue: COMPRESS-451.
o ZipArchiveInputStream failed to read some files with stored
entries using a data descriptor.
Issue: COMPRESS-454.
Changes:
o Fixed some code examples.
Github Pull Request #63.
Thanks to Marchenko Sergey.
o The streams returned by ZipFile and most other decompressing
streams now provide information about the number of compressed
and uncompressed bytes read so far. This may be used to detect
a ZipBomb if the compression ratio exceeds a certain
threshold, for example.
For SevenZFile a new method returns the statistics for the
current entry.
Issue: COMPRESS-445.
Thanks to Andreas Beeker.
o Added a workaround for a bug in AdoptOpenJDK for S/390 to
BZip2CompressorInputStream.
Issue: COMPRESS-453.
Release 1.16.1
--------------
Fixed Bug:
o Fixed the OSGi manifest entry for imports that has been broken
in 1.16.
Issue: COMPRESS-442.
Release 1.16
------------
New features:
o Add read-only support for Zstandard compression based on the
Zstd-jni project.
Issue: COMPRESS-423. Thanks to Andre F de Miranda.
o Added auto-detection for Zstandard compressed streams.
Issue: COMPRESS-425.
o Added write-support for Zstandard compression.
Issue: COMPRESS-426.
o Added read-only DEFLATE64 support to ZIP archives and as
stand-alone CompressorInputStream.
Issue: COMPRESS-380. Thanks to Christian Marquez Grabia.
o Added read-only DEFLATE64 support to 7z archives.
Issue: COMPRESS-437.
Fixed Bugs:
o Synchronized iteration over a synchronizedList in
ParallelScatterZipCreator.
Issue: COMPRESS-430. Thanks to Bruno P. Kinoshita.
o ZipFile could get stuck in an infinite loop when parsing ZIP
archives with certain strong encryption headers.
Issue: COMPRESS-432.
o Added improved checks to detect corrupted bzip2 streams and
throw the expected IOException rather than obscure
RuntimeExceptions.
Issue: COMPRESS-424.
Changes:
o Replaces instanceof checks with a type marker in LZ77 support code.
Issue: COMPRESS-435. Thanks to BELUGA BEHR.
o Updated XZ for Java dependency to 1.8 in order to pick up bug fix
to LZMA2InputStream's available method.
o ZipArchiveEntry now exposes how the name or comment have been
determined when the entry was read.
Issue: COMPRESS-429. Thanks to Damiano Albani.
o ZipFile.getInputStream will now always buffer the stream
internally in order to improve read performance.
Issue: COMPRESS-438.
o Speed improvement for DEFLATE64 decompression.
Issue: COMPRESS-440. Thanks to Dawid Weiss.
o Added a few extra sanity checks for the rarer compression
methods used in ZIP archives.
Issue: COMPRESS-436.
o Simplified the special handling for the dummy byte required by
zlib when using java.util.zip.Inflater.
Issue: COMPRESS-441.
o Various code cleanups.
Github Pull Request #61. Thanks to Shahab Kondri.
o TarArchiveEntry's preserveLeadingSlashes constructor argument
has been renamed and can now also be used to preserve the
drive letter on Windows.
Release 1.15
------------
New features:
o Added magic MANIFEST entry Automatic-Module-Name so the module
name will be org.apache.commons.compress when the jar is used
as an automatic module in Java9.
Issue: COMPRESS-397.
o Added a new utility class FixedLengthBlockOutputStream that
can be used to ensure writing always happens in blocks of a
given size.
Issue: COMPRESS-405. Thanks to Simon Spero.
o It is now possible to specify/read custom PAX headers when
writing/reading tar archives.
Issue: COMPRESS-400. Thanks to Simon Spero.
Fixed Bugs:
o Make sure "version needed to extract" in local file header and
central directory of a ZIP archive agree with each other.
Also ensure the version is set to 2.0 if DEFLATE is used.
Issue: COMPRESS-394.
o Don't use a data descriptor in ZIP archives when copying a raw
entry that already knows its size and CRC information.
Issue: COMPRESS-395.
o Travis build redundantly repeats compilation and tests redundantly
GitHub Pull Request #43. Thanks to Simon Spero.
Issue: COMPRESS-413
o The MANIFEST of 1.14 lacks an OSGi Import-Package for XZ for
Java.
Issue: COMPRESS-396.
o BUILDING.md now passes the RAT check.
Issue: COMPRESS-406. Thanks to Simon Spero.
o Made sure ChecksumCalculatingInputStream receives valid
checksum and input stream instances via the constructor.
Issue: COMPRESS-412. Thanks to Michael Hausegger.
o TarArchiveOutputStream now verifies the block and record sizes
specified at construction time are compatible with the tar
specification. In particular 512 is the only record size
accepted and the block size must be a multiple of 512.
Issue: COMPRESS-407. Thanks to Simon Spero.
o Fixed class names of CpioArchiveEntry and
CpioArchiveInputStream in various Javadocs.
Issue: COMPRESS-415.
o The code of the extended timestamp zip extra field incorrectly
assumed the time was stored as unsigned 32-bit int and thus
created incorrect results for years after 2037.
Issue: COMPRESS-416. Thanks to Simon Spero.
o Removed ZipEncoding code that became obsolete when we started
to require Java 5 as baseline long ago.
Issue: COMPRESS-410. Thanks to Simon Spero.
o The tar package will no longer try to parse the major and
minor device numbers unless the entry represents a character
or block special file.
Issue: COMPRESS-417.
o When reading tar headers with name fields containing embedded
NULs, the name will now be terminated at the first NUL byte.
Issue: COMPRESS-421. Thanks to Roel Spilker.
o Simplified TarArchiveOutputStream by replacing the internal
buffering with new class FixedLengthBlockOutputStream.
Issue: COMPRESS-409.
Release 1.14
------------
New features:
o Added write support for Snappy.
Issue: COMPRESS-246.
o Added support for LZ4 (block and frame format).
Issue: COMPRESS-271.
o Add static detect(InputStream in) to CompressorStreamFactory
and ArchiveStreamFactory
Issue: COMPRESS-385.
o Added a way to limit amount of memory ZCompressorStream may
use.
Issue: COMPRESS-382. Thanks to Tim Allison.
o Added a way to limit amount of memory ZCompressorStream may
use.
Issue: COMPRESS-386. Thanks to Tim Allison.
o Added a way to limit amount of memory LZMACompressorStream and
XZCompressorInputStream may use.
Issue: COMPRESS-382. Thanks to Tim Allison.
o Add Brotli decoder based on the Google Brotli library.
Issue: COMPRESS-392. Thanks to Philippe Mouawad.
o ZipEntry now exposes its data offset.
Issue: COMPRESS-390. Thanks to Zbynek Vyskovsky.
o Using ZipArchiveEntry's setAlignment it is now possible to
ensure the data offset of an entry starts at a file position
that at word or page boundaries.
A new extra field has been added for this purpose.
Issue: COMPRESS-391. Thanks to Zbynek Vyskovsky.
Fixed Bugs:
o SnappyCompressorInputStream slides the window too early
leading to ArrayIndexOutOfBoundsExceptions for some streams.
Issue: COMPRESS-378.
o ZipArchiveEntry#isUnixSymlink now only returns true if the
corresponding link flag is the only file-type flag set.
Issue: COMPRESS-379. Thanks to Guillaume Boué.
o Fixed an integer overflow in CPIO's CRC calculation.
Pull Request #17. Thanks to Daniel Collin.
o Make unit tests work on Windows paths with spaces in their names.
Issue: COMPRESS-387.
o Internal location pointer in ZipFile could get incremented
even if nothing had been read.
Issue: COMPRESS-389.
o LZMACompressorOutputStream#flush would throw an exception
rather than be the NOP it promised to be.
Issue: COMPRESS-393.
Changes:
o The blocksize for FramedSnappyCompressorInputStream can now be
configured as some IWA files seem to be using blocks larger
than the default 32k.
Issue: COMPRESS-358.
o BZip2CompressorInputstream now uses BitInputStream internally.
Pull Request #13. Thanks to Thomas Meyer.
o Improved performance for concurrent reads from ZipFile when
reading from a file.
Issue: COMPRESS-388. Thanks to Zbynek Vyskovsky.
Release 1.13
------------
Commons Compress 1.13 is the first version to require Java 7 at
runtime.
Changes in this version include:
New features:
o SevenZFile, SevenZOutputFile, ZipFile and
ZipArchiveOutputStream can now work on non-file resources if
they can be accessed via SeekableByteChannel.
Issue: COMPRESS-327.
o Allow compressor extensions through a standard JRE ServiceLoader.
Issue: COMPRESS-368.
o Allow archive extensions through a standard JRE ServiceLoader.
Issue: COMPRESS-369.
o Add write support for the legacy LZMA format, this requires XZ
for Java 1.6.
Issue: COMPRESS-373.
o Add write support for the legacy LZMA stream to 7z, this
requires XZ for Java 1.6.
Issue: COMPRESS-374.
o Allow the clients of ParallelScatterZipCreator to provide
ZipArchiveEntryRequestSupplier.
Issue: COMPRESS-375. Thanks to Plamen Totev.
o Add a version-independent link to the API docs of the latest
release.
Issue: COMPRESS-372.
Fixed Bugs:
o BitInputStream could return bad results when overflowing
internally - if two consecutive reads tried to read more than
64 bits.
Issue: COMPRESS-363.
o ZipArchiveInputStream.closeEntry does not properly advance to
next entry if there are junk bytes at end of data section.
Issue: COMPRESS-364. Thanks to Mike Mole.
o ZipArchiveInputStream now throws an Exception if it encounters
a broken ZIP archive rather than signaling end-of-archive.
Issue: COMPRESS-367. Thanks to Mike Mole.
o ScatterZipOutputStream didn't close the StreamCompressor
causing a potential resource leak.
Issue: COMPRESS-377.
Changes:
o Update Java requirement from 6 to 7.
Issue: COMPRESS-360.
o Clarified which TarArchiveEntry methods are useless for
entries read from an archive.
Issue: COMPRESS-366.
Release 1.12
------------
Commons Compress 1.12 is the first version to require Java 6 at
runtime.
Release 1.12 changes the behavior of BZip2CompressorOutputStream's
finalize method so that it no longer invokes finish. This is going to
break code that relied on the finalizer to clean up an unfinished
stream. The code will need to be changed to call finish or close
itself. Note that a finalizer is not guaranteed to run, so the feature
was not 100% effective in any case.
New features:
o FramedSnappyCompressorInputStream now supports the dialect of
Snappy used by the IWA files contained within the zip archives
used in Apple's iWork 13 files.
Issue: COMPRESS-352.
Fixed Bugs:
o SevenZFile.read() throws an IllegalStateException for empty entries.
Issue: COMPRESS-348.
o TarArchiveInputStream failed to parse PAX headers that included
blank lines.
Issue: COMPRESS-355. Thanks to Jeremy Gustie.
o TarArchiveInputStream failed to parse PAX headers whose tar entry
name ended with a slash.
Issue: COMPRESS-356. Thanks to Jeremy Gustie.
Changes:
o Update requirement from Java 5 to 6.