You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2019/08/11 15:50:52 UTC
[commons-compress] 02/03: assorted boy-scout fixes and cleanups
while looking for something else
This is an automated email from the ASF dual-hosted git repository.
bodewig pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit d8ca982fa574c18e1501ac1018ec3466a6b73de9
Author: Stefan Bodewig <bo...@apache.org>
AuthorDate: Sun Aug 11 16:59:35 2019 +0200
assorted boy-scout fixes and cleanups while looking for something else
---
.../compress/archivers/ar/ArArchiveInputStream.java | 13 +++++--------
.../compress/archivers/arj/ArjArchiveInputStream.java | 19 ++++++++++---------
.../archivers/sevenz/AES256SHA256Decoder.java | 5 ++++-
.../apache/commons/compress/archivers/sevenz/CLI.java | 5 +++--
.../commons/compress/archivers/zip/AsiExtraField.java | 2 +-
.../commons/compress/archivers/zip/BinaryTree.java | 9 +++++++--
.../compress/archivers/zip/ExtraFieldUtils.java | 14 +++++++-------
.../compress/archivers/zip/PKWareExtraHeader.java | 8 +++-----
.../archivers/zip/UnparseableExtraFieldData.java | 8 ++++----
.../archivers/zip/UnrecognizedExtraField.java | 9 ++++-----
.../archivers/zip/X5455_ExtendedTimestamp.java | 7 ++-----
.../compress/archivers/zip/ZipEightByteInteger.java | 4 ++--
.../commons/compress/archivers/zip/ZipUtil.java | 7 +++----
.../compressors/gzip/GzipCompressorInputStream.java | 14 +++++++-------
.../compress/compressors/lzw/LZWInputStream.java | 7 ++++---
.../pack200/InMemoryCachingStreamBridge.java | 4 ++--
.../pack200/TempFileCachingStreamBridge.java | 2 +-
.../compress/archivers/zip/AsiExtraFieldTest.java | 2 +-
18 files changed, 70 insertions(+), 69 deletions(-)
diff --git a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
index bd871df..97b0664 100644
--- a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
@@ -21,6 +21,7 @@ package org.apache.commons.compress.archivers.ar;
import java.io.EOFException;
import java.io.IOException;
import java.io.InputStream;
+import java.util.Arrays;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveInputStream;
@@ -106,10 +107,8 @@ public class ArArchiveInputStream extends ArchiveInputStream {
if (read != expected.length) {
throw new IOException("Failed to read header. Occured at byte: " + getBytesRead());
}
- for (int i = 0; i < expected.length; i++) {
- if (expected[i] != realized[i]) {
- throw new IOException("Invalid header " + ArchiveUtils.toAsciiString(realized));
- }
+ if (!Arrays.equals(expected, realized)) {
+ throw new IOException("Invalid header " + ArchiveUtils.toAsciiString(realized));
}
}
@@ -140,10 +139,8 @@ public class ArArchiveInputStream extends ArchiveInputStream {
if (read != expected.length) {
throw new IOException("Failed to read entry trailer. Occured at byte: " + getBytesRead());
}
- for (int i = 0; i < expected.length; i++) {
- if (expected[i] != realized[i]) {
- throw new IOException("Invalid entry trailer. not read the content? Occured at byte: " + getBytesRead());
- }
+ if (!Arrays.equals(expected, realized)) {
+ throw new IOException("Invalid entry trailer. not read the content? Occured at byte: " + getBytesRead());
}
}
diff --git a/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java b/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java
index 089f906..2f88857 100644
--- a/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java
@@ -109,16 +109,17 @@ public class ArjArchiveInputStream extends ArchiveInputStream {
}
private String readString(final DataInputStream dataIn) throws IOException {
- final ByteArrayOutputStream buffer = new ByteArrayOutputStream();
- int nextByte;
- while ((nextByte = dataIn.readUnsignedByte()) != 0) {
- buffer.write(nextByte);
- }
- if (charsetName != null) {
- return new String(buffer.toByteArray(), charsetName);
+ try (final ByteArrayOutputStream buffer = new ByteArrayOutputStream()) {
+ int nextByte;
+ while ((nextByte = dataIn.readUnsignedByte()) != 0) {
+ buffer.write(nextByte);
+ }
+ if (charsetName != null) {
+ return new String(buffer.toByteArray(), charsetName);
+ }
+ // intentionally using the default encoding as that's the contract for a null charsetName
+ return new String(buffer.toByteArray());
}
- // intentionally using the default encoding as that's the contract for a null charsetName
- return new String(buffer.toByteArray());
}
private void readFully(final DataInputStream dataIn, final byte[] b)
diff --git a/src/main/java/org/apache/commons/compress/archivers/sevenz/AES256SHA256Decoder.java b/src/main/java/org/apache/commons/compress/archivers/sevenz/AES256SHA256Decoder.java
index e746801..c752a1b 100644
--- a/src/main/java/org/apache/commons/compress/archivers/sevenz/AES256SHA256Decoder.java
+++ b/src/main/java/org/apache/commons/compress/archivers/sevenz/AES256SHA256Decoder.java
@@ -111,7 +111,10 @@ class AES256SHA256Decoder extends CoderBase {
}
@Override
- public void close() {
+ public void close() throws IOException {
+ if (cipherInputStream != null) {
+ cipherInputStream.close();
+ }
}
};
}
diff --git a/src/main/java/org/apache/commons/compress/archivers/sevenz/CLI.java b/src/main/java/org/apache/commons/compress/archivers/sevenz/CLI.java
index 18240d3..afa5371 100644
--- a/src/main/java/org/apache/commons/compress/archivers/sevenz/CLI.java
+++ b/src/main/java/org/apache/commons/compress/archivers/sevenz/CLI.java
@@ -18,8 +18,9 @@
package org.apache.commons.compress.archivers.sevenz;
import java.io.File;
-import java.io.FileOutputStream;
import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.file.Files;
public class CLI {
@@ -82,7 +83,7 @@ public class CLI {
if (parent != null && !parent.exists() && !parent.mkdirs()) {
throw new IOException("Cannot create " + parent);
}
- try (final FileOutputStream fos = new FileOutputStream(outFile)) {
+ try (final OutputStream fos = Files.newOutputStream(outFile.toPath())) {
final long total = entry.getSize();
long off = 0;
while (off < total) {
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
index 490943b..d5dac8e 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
@@ -274,7 +274,7 @@ public class AsiExtraField implements ZipExtraField, UnixStat, Cloneable {
crc.update(tmp);
final long realChecksum = crc.getValue();
if (givenChecksum != realChecksum) {
- throw new ZipException("Bad CRC checksum "
+ throw new ZipException("Bad CRC checksum, expected "
+ Long.toHexString(givenChecksum)
+ " instead of "
+ Long.toHexString(realChecksum));
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/BinaryTree.java b/src/main/java/org/apache/commons/compress/archivers/zip/BinaryTree.java
index 9b3c377..3ff1428 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/BinaryTree.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/BinaryTree.java
@@ -19,11 +19,13 @@
package org.apache.commons.compress.archivers.zip;
-import java.io.DataInputStream;
+import java.io.EOFException;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
+import org.apache.commons.compress.utils.IOUtils;
+
/**
* Binary tree of positive values.
*
@@ -115,7 +117,10 @@ class BinaryTree {
}
final byte[] encodedTree = new byte[size];
- new DataInputStream(in).readFully(encodedTree);
+ final int read = IOUtils.readFully(in, encodedTree);
+ if (read != size) {
+ throw new EOFException();
+ }
/** The maximum bit length for a value (16 or lower) */
int maxLength = 0;
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
index 304ca38..402d6a5 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
@@ -258,16 +258,16 @@ public class ExtraFieldUtils {
System.arraycopy(data[i].getCentralDirectoryLength().getBytes(),
0, result, start + 2, 2);
start += WORD;
- final byte[] local = data[i].getCentralDirectoryData();
- if (local != null) {
- System.arraycopy(local, 0, result, start, local.length);
- start += local.length;
+ final byte[] central = data[i].getCentralDirectoryData();
+ if (central != null) {
+ System.arraycopy(central, 0, result, start, central.length);
+ start += central.length;
}
}
if (lastIsUnparseableHolder) {
- final byte[] local = data[data.length - 1].getCentralDirectoryData();
- if (local != null) {
- System.arraycopy(local, 0, result, start, local.length);
+ final byte[] central = data[data.length - 1].getCentralDirectoryData();
+ if (central != null) {
+ System.arraycopy(central, 0, result, start, central.length);
}
}
return result;
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
index 7177c87..a523ad2 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
@@ -18,6 +18,7 @@
*/
package org.apache.commons.compress.archivers.zip;
+import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
@@ -170,9 +171,7 @@ public abstract class PKWareExtraHeader implements ZipExtraField {
*/
@Override
public void parseFromLocalFileData(final byte[] data, final int offset, final int length) {
- final byte[] tmp = new byte[length];
- System.arraycopy(data, offset, tmp, 0, length);
- setLocalFileDataData(tmp);
+ setLocalFileDataData(Arrays.copyOfRange(data, offset, offset + length));
}
/**
@@ -186,8 +185,7 @@ public abstract class PKWareExtraHeader implements ZipExtraField {
*/
@Override
public void parseFromCentralDirectoryData(final byte[] data, final int offset, final int length) {
- final byte[] tmp = new byte[length];
- System.arraycopy(data, offset, tmp, 0, length);
+ final byte[] tmp = Arrays.copyOfRange(data, offset, offset + length);
setCentralDirectoryData(tmp);
if (localData == null) {
setLocalFileDataData(tmp);
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
index d7d24df..3735489 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
@@ -18,6 +18,8 @@
*/
package org.apache.commons.compress.archivers.zip;
+import java.util.Arrays;
+
/**
* Wrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data.
*
@@ -96,8 +98,7 @@ public final class UnparseableExtraFieldData implements ZipExtraField {
*/
@Override
public void parseFromLocalFileData(final byte[] buffer, final int offset, final int length) {
- localFileData = new byte[length];
- System.arraycopy(buffer, offset, localFileData, 0, length);
+ localFileData = Arrays.copyOfRange(buffer, offset, offset + length);
}
/**
@@ -110,8 +111,7 @@ public final class UnparseableExtraFieldData implements ZipExtraField {
@Override
public void parseFromCentralDirectoryData(final byte[] buffer, final int offset,
final int length) {
- centralDirectoryData = new byte[length];
- System.arraycopy(buffer, offset, centralDirectoryData, 0, length);
+ centralDirectoryData = Arrays.copyOfRange(buffer, offset, offset + length);
if (localFileData == null) {
parseFromLocalFileData(buffer, offset, length);
}
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java
index f8ea8b9..5b360dc 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java
@@ -18,6 +18,8 @@
*/
package org.apache.commons.compress.archivers.zip;
+import java.util.Arrays;
+
/**
* Simple placeholder for all those extra fields we don't want to deal
* with.
@@ -130,9 +132,7 @@ public class UnrecognizedExtraField implements ZipExtraField {
*/
@Override
public void parseFromLocalFileData(final byte[] data, final int offset, final int length) {
- final byte[] tmp = new byte[length];
- System.arraycopy(data, offset, tmp, 0, length);
- setLocalFileDataData(tmp);
+ setLocalFileDataData(Arrays.copyOfRange(data, offset, offset + length));
}
/**
@@ -144,8 +144,7 @@ public class UnrecognizedExtraField implements ZipExtraField {
@Override
public void parseFromCentralDirectoryData(final byte[] data, final int offset,
final int length) {
- final byte[] tmp = new byte[length];
- System.arraycopy(data, offset, tmp, 0, length);
+ final byte[] tmp = Arrays.copyOfRange(data, offset, offset + length);
setCentralDirectoryData(tmp);
if (localData == null) {
setLocalFileDataData(tmp);
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
index 28590c2..ac3fada 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
@@ -19,6 +19,7 @@
package org.apache.commons.compress.archivers.zip;
import java.io.Serializable;
+import java.util.Arrays;
import java.util.Date;
import java.util.zip.ZipException;
@@ -200,13 +201,9 @@ public class X5455_ExtendedTimestamp implements ZipExtraField, Cloneable, Serial
*/
@Override
public byte[] getCentralDirectoryData() {
- final byte[] centralData = new byte[getCentralDirectoryLength().getValue()];
- final byte[] localData = getLocalFileDataData();
-
// Truncate out create & access time (last 8 bytes) from
// the copy of the local data we obtained:
- System.arraycopy(localData, 0, centralData, 0, centralData.length);
- return centralData;
+ return Arrays.copyOf(getLocalFileDataData(), getCentralDirectoryLength().getValue());
}
/**
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
index 9d9e2ec..0efb997 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
@@ -117,8 +117,8 @@ public final class ZipEightByteInteger implements Serializable {
}
/**
- * Get value as Java long.
- * @return value as a long
+ * Get value as Java BigInteger.
+ * @return value as a BigInteger
*/
public BigInteger getValue() {
return value;
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
index 8cc3e6a..e086412 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
@@ -19,6 +19,7 @@ package org.apache.commons.compress.archivers.zip;
import java.io.IOException;
import java.math.BigInteger;
+import java.util.Arrays;
import java.util.Calendar;
import java.util.Date;
import java.util.zip.CRC32;
@@ -75,7 +76,7 @@ public abstract class ZipUtil {
final int year = c.get(Calendar.YEAR);
if (year < 1980) {
- System.arraycopy(DOS_TIME_MIN, 0, buf, offset, DOS_TIME_MIN.length);// stop callers from changing the array
+ copy(DOS_TIME_MIN, buf, offset); // stop callers from changing the array
return;
}
final int month = c.get(Calendar.MONTH) + 1;
@@ -290,9 +291,7 @@ public abstract class ZipUtil {
*/
static byte[] copy(final byte[] from) {
if (from != null) {
- final byte[] to = new byte[from.length];
- System.arraycopy(from, 0, to, 0, to.length);
- return to;
+ return Arrays.copyOf(from, from.length);
}
return null;
}
diff --git a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
index 521664b..99b48ad 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
@@ -182,7 +182,6 @@ public class GzipCompressorInputStream extends CompressorInputStream
// Check the magic bytes without a possibility of EOFException.
final int magic0 = in.read();
- final int magic1 = in.read();
// If end of input was reached after decompressing at least
// one .gz member, we have reached the end of the file successfully.
@@ -190,7 +189,7 @@ public class GzipCompressorInputStream extends CompressorInputStream
return false;
}
- if (magic0 != 31 || magic1 != 139) {
+ if (magic0 != 31 || in.read() != 139) {
throw new IOException(isFirstMember
? "Input is not in the .gz format"
: "Garbage after a valid .gz stream");
@@ -266,12 +265,13 @@ public class GzipCompressorInputStream extends CompressorInputStream
}
private static byte[] readToNull(final DataInput inData) throws IOException {
- final ByteArrayOutputStream bos = new ByteArrayOutputStream();
- int b = 0;
- while ((b = inData.readUnsignedByte()) != 0x00) { // NOPMD NOSONAR
- bos.write(b);
+ try (final ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
+ int b = 0;
+ while ((b = inData.readUnsignedByte()) != 0x00) { // NOPMD NOSONAR
+ bos.write(b);
+ }
+ return bos.toByteArray();
}
- return bos.toByteArray();
}
@Override
diff --git a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
index 624d9e6..18b8a48 100644
--- a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
@@ -98,7 +98,7 @@ public abstract class LZWInputStream extends CompressorInputStream implements In
/**
* Read the next code and expand it.
- * @return the expanded next code
+ * @return the expanded next code, negative on EOF
* @throws IOException on error
*/
protected abstract int decompressNextSymbol() throws IOException;
@@ -180,7 +180,7 @@ public abstract class LZWInputStream extends CompressorInputStream implements In
* @param previousCode the previous code
* @param character the character to append
* @param maxTableSize the maximum table size
- * @return the new code
+ * @return the new code or -1 if maxTableSize has been reached already
*/
protected int addEntry(final int previousCode, final byte character, final int maxTableSize) {
if (tableSize < maxTableSize) {
@@ -193,7 +193,8 @@ public abstract class LZWInputStream extends CompressorInputStream implements In
/**
* Add entry for repeat of previousCode we haven't added, yet.
- * @return new code for a repeat of the previous code
+ * @return new code for a repeat of the previous code or -1 if
+ * maxTableSize has been reached already
* @throws IOException on error
*/
protected int addRepeatOfPreviousCode() throws IOException {
diff --git a/src/main/java/org/apache/commons/compress/compressors/pack200/InMemoryCachingStreamBridge.java b/src/main/java/org/apache/commons/compress/compressors/pack200/InMemoryCachingStreamBridge.java
index e1fdc2c..1eedd93 100644
--- a/src/main/java/org/apache/commons/compress/compressors/pack200/InMemoryCachingStreamBridge.java
+++ b/src/main/java/org/apache/commons/compress/compressors/pack200/InMemoryCachingStreamBridge.java
@@ -25,7 +25,7 @@ import java.io.IOException;
import java.io.InputStream;
/**
- * StreamSwitcher that caches all data written to the output side in
+ * StreamBridge that caches all data written to the output side in
* memory.
* @since 1.3
*/
@@ -39,4 +39,4 @@ class InMemoryCachingStreamBridge extends StreamBridge {
return new ByteArrayInputStream(((ByteArrayOutputStream) out)
.toByteArray());
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/apache/commons/compress/compressors/pack200/TempFileCachingStreamBridge.java b/src/main/java/org/apache/commons/compress/compressors/pack200/TempFileCachingStreamBridge.java
index 27ed211..5403eed 100644
--- a/src/main/java/org/apache/commons/compress/compressors/pack200/TempFileCachingStreamBridge.java
+++ b/src/main/java/org/apache/commons/compress/compressors/pack200/TempFileCachingStreamBridge.java
@@ -26,7 +26,7 @@ import java.io.InputStream;
import java.nio.file.Files;
/**
- * StreamSwitcher that caches all data written to the output side in
+ * StreamBridge that caches all data written to the output side in
* a temporary file.
* @since 1.3
*/
diff --git a/src/test/java/org/apache/commons/compress/archivers/zip/AsiExtraFieldTest.java b/src/test/java/org/apache/commons/compress/archivers/zip/AsiExtraFieldTest.java
index 955576d..22332bb 100644
--- a/src/test/java/org/apache/commons/compress/archivers/zip/AsiExtraFieldTest.java
+++ b/src/test/java/org/apache/commons/compress/archivers/zip/AsiExtraFieldTest.java
@@ -136,7 +136,7 @@ public class AsiExtraFieldTest implements UnixStat {
a.parseFromLocalFileData(data, 0, data.length);
fail("should raise bad CRC exception");
} catch (final Exception e) {
- assertEquals("Bad CRC checksum 0 instead of ebf018e",
+ assertEquals("Bad CRC checksum, expected 0 instead of ebf018e",
e.getMessage());
}
}