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 2018/08/10 04:49:52 UTC
commons-compress git commit: COMPRESS-462 can't read from AR without
opening an entry
Repository: commons-compress
Updated Branches:
refs/heads/master a41ce6892 -> ba53647bf
COMPRESS-462 can't read from AR without opening an entry
Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/ba53647b
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/ba53647b
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/ba53647b
Branch: refs/heads/master
Commit: ba53647bf0fa16501445c7ec50d0ffa4a8288eff
Parents: a41ce68
Author: Stefan Bodewig <bo...@apache.org>
Authored: Fri Aug 10 06:48:35 2018 +0200
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Fri Aug 10 06:49:40 2018 +0200
----------------------------------------------------------------------
src/changes/changes.xml | 4 +
.../archivers/ar/ArArchiveInputStream.java | 125 +++++++++++--------
.../archivers/ar/ArArchiveInputStreamTest.java | 3 +-
3 files changed, 81 insertions(+), 51 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-compress/blob/ba53647b/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 7546871..11b61ca 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -79,6 +79,10 @@ The <action> type attribute can be add,update,fix,remove.
corrupted stored entry and even return > 0 after hitting the
end of the archive.
</action>
+ <action issue="COMPRESS-462" type="fix" date="2018-08-10">
+ ArArchiveInputStream#read would allow to read from the stream
+ without opening an entry at all.
+ </action>
</release>
<release version="1.17" date="2018-06-03"
description="Release 1.17">
http://git-wip-us.apache.org/repos/asf/commons-compress/blob/ba53647b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
----------------------------------------------------------------------
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 ddd122e..3ed8f2f 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
@@ -54,12 +54,23 @@ public class ArArchiveInputStream extends ArchiveInputStream {
*/
private long entryOffset = -1;
- // cached buffers - must only be used locally in the class (COMPRESS-172 - reduce garbage collection)
- private final byte[] nameBuf = new byte[16];
- private final byte[] lastModifiedBuf = new byte[12];
- private final byte[] idBuf = new byte[6];
- private final byte[] fileModeBuf = new byte[8];
- private final byte[] lengthBuf = new byte[10];
+ // offsets and length of meta data parts
+ private static final int NAME_OFFSET = 0;
+ private static final int NAME_LEN = 16;
+ private static final int LAST_MODIFIED_OFFSET = NAME_LEN;
+ private static final int LAST_MODIFIED_LEN = 12;
+ private static final int USER_ID_OFFSET = LAST_MODIFIED_OFFSET + LAST_MODIFIED_LEN;
+ private static final int USER_ID_LEN = 6;
+ private static final int GROUP_ID_OFFSET = USER_ID_OFFSET + USER_ID_LEN;
+ private static final int GROUP_ID_LEN = 6;
+ private static final int FILE_MODE_OFFSET = GROUP_ID_OFFSET + GROUP_ID_LEN;
+ private static final int FILE_MODE_LEN = 8;
+ private static final int LENGTH_OFFSET = FILE_MODE_OFFSET + FILE_MODE_LEN;
+ private static final int LENGTH_LEN = 10;
+
+ // cached buffer for meta data - must only be used locally in the class (COMPRESS-172 - reduce garbage collection)
+ private final byte[] metaData =
+ new byte[NAME_LEN + LAST_MODIFIED_LEN + USER_ID_LEN + GROUP_ID_LEN + FILE_MODE_LEN + LENGTH_LEN];
/**
* Constructs an Ar input stream with the referenced stream
@@ -82,14 +93,16 @@ public class ArArchiveInputStream extends ArchiveInputStream {
public ArArchiveEntry getNextArEntry() throws IOException {
if (currentEntry != null) {
final long entryEnd = entryOffset + currentEntry.getLength();
- IOUtils.skip(this, entryEnd - offset);
+ long skipped = IOUtils.skip(input, entryEnd - offset);
+ trackReadBytes(skipped);
currentEntry = null;
}
if (offset == 0) {
final byte[] expected = ArchiveUtils.toAsciiBytes(ArArchiveEntry.HEADER);
final byte[] realized = new byte[expected.length];
- final int read = IOUtils.readFully(this, realized);
+ final int read = IOUtils.readFully(input, realized);
+ trackReadBytes(read);
if (read != expected.length) {
throw new IOException("failed to read header. Occured at byte: " + getBytesRead());
}
@@ -100,27 +113,31 @@ public class ArArchiveInputStream extends ArchiveInputStream {
}
}
- if (offset % 2 != 0 && read() < 0) {
- // hit eof
- return null;
+ if (offset % 2 != 0) {
+ if (input.read() < 0) {
+ // hit eof
+ return null;
+ }
+ trackReadBytes(1);
}
if (input.available() == 0) {
return null;
}
- IOUtils.readFully(this, nameBuf);
- IOUtils.readFully(this, lastModifiedBuf);
- IOUtils.readFully(this, idBuf);
- final int userId = asInt(idBuf, true);
- IOUtils.readFully(this, idBuf);
- IOUtils.readFully(this, fileModeBuf);
- IOUtils.readFully(this, lengthBuf);
+ {
+ final int read = IOUtils.readFully(input, metaData);
+ trackReadBytes(read);
+ if (read < metaData.length) {
+ throw new IOException("truncated ar archive");
+ }
+ }
{
final byte[] expected = ArchiveUtils.toAsciiBytes(ArArchiveEntry.TRAILER);
final byte[] realized = new byte[expected.length];
- final int read = IOUtils.readFully(this, realized);
+ final int read = IOUtils.readFully(input, realized);
+ trackReadBytes(read);
if (read != expected.length) {
throw new IOException("failed to read entry trailer. Occured at byte: " + getBytesRead());
}
@@ -136,13 +153,13 @@ public class ArArchiveInputStream extends ArchiveInputStream {
// GNU ar uses a '/' to mark the end of the filename; this allows for the use of spaces without the use of an extended filename.
// entry name is stored as ASCII string
- String temp = ArchiveUtils.toAsciiString(nameBuf).trim();
+ String temp = ArchiveUtils.toAsciiString(metaData, NAME_OFFSET, NAME_LEN).trim();
if (isGNUStringTable(temp)) { // GNU extended filenames entry
- currentEntry = readGNUStringTable(lengthBuf);
+ currentEntry = readGNUStringTable(metaData, LENGTH_OFFSET, LENGTH_LEN);
return getNextArEntry();
}
- long len = asLong(lengthBuf);
+ long len = asLong(metaData, LENGTH_OFFSET, LENGTH_LEN);
if (temp.endsWith("/")) { // GNU terminator
temp = temp.substring(0, temp.length() - 1);
} else if (isGNULongName(temp)) {
@@ -158,10 +175,11 @@ public class ArArchiveInputStream extends ArchiveInputStream {
entryOffset += nameLen;
}
- currentEntry = new ArArchiveEntry(temp, len, userId,
- asInt(idBuf, true),
- asInt(fileModeBuf, 8),
- asLong(lastModifiedBuf));
+ currentEntry = new ArArchiveEntry(temp, len,
+ asInt(metaData, USER_ID_OFFSET, USER_ID_LEN, true),
+ asInt(metaData, GROUP_ID_OFFSET, GROUP_ID_LEN, true),
+ asInt(metaData, FILE_MODE_OFFSET, FILE_MODE_LEN, 8),
+ asLong(metaData, LAST_MODIFIED_OFFSET, LAST_MODIFIED_LEN));
return currentEntry;
}
@@ -187,24 +205,24 @@ public class ArArchiveInputStream extends ArchiveInputStream {
throw new IOException("Failed to read entry: " + offset);
}
- private long asLong(final byte[] byteArray) {
- return Long.parseLong(ArchiveUtils.toAsciiString(byteArray).trim());
+ private long asLong(final byte[] byteArray, int offset, int len) {
+ return Long.parseLong(ArchiveUtils.toAsciiString(byteArray, offset, len).trim());
}
- private int asInt(final byte[] byteArray) {
- return asInt(byteArray, 10, false);
+ private int asInt(final byte[] byteArray, int offset, int len) {
+ return asInt(byteArray, offset, len, 10, false);
}
- private int asInt(final byte[] byteArray, final boolean treatBlankAsZero) {
- return asInt(byteArray, 10, treatBlankAsZero);
+ private int asInt(final byte[] byteArray, int offset, int len, final boolean treatBlankAsZero) {
+ return asInt(byteArray, offset, len, 10, treatBlankAsZero);
}
- private int asInt(final byte[] byteArray, final int base) {
- return asInt(byteArray, base, false);
+ private int asInt(final byte[] byteArray, int offset, int len, final int base) {
+ return asInt(byteArray, offset, len, base, false);
}
- private int asInt(final byte[] byteArray, final int base, final boolean treatBlankAsZero) {
- final String string = ArchiveUtils.toAsciiString(byteArray).trim();
+ private int asInt(final byte[] byteArray, int offset, int len, final int base, final boolean treatBlankAsZero) {
+ final String string = ArchiveUtils.toAsciiString(byteArray, offset, len).trim();
if (string.length() == 0 && treatBlankAsZero) {
return 0;
}
@@ -243,18 +261,18 @@ public class ArArchiveInputStream extends ArchiveInputStream {
*/
@Override
public int read(final byte[] b, final int off, final int len) throws IOException {
+ if (currentEntry == null) {
+ throw new IllegalStateException("No current ar entry");
+ }
int toRead = len;
- if (currentEntry != null) {
- final long entryEnd = entryOffset + currentEntry.getLength();
- if (len > 0 && entryEnd > offset) {
- toRead = (int) Math.min(len, entryEnd - offset);
- } else {
- return -1;
- }
+ final long entryEnd = entryOffset + currentEntry.getLength();
+ if (len > 0 && entryEnd > offset) {
+ toRead = (int) Math.min(len, entryEnd - offset);
+ } else {
+ return -1;
}
final int ret = this.input.read(b, off, toRead);
- count(ret);
- offset += ret > 0 ? ret : 0;
+ trackReadBytes(ret);
return ret;
}
@@ -322,7 +340,8 @@ public class ArArchiveInputStream extends ArchiveInputStream {
final int nameLen =
Integer.parseInt(bsdLongName.substring(BSD_LONGNAME_PREFIX_LEN));
final byte[] name = new byte[nameLen];
- final int read = IOUtils.readFully(this, name);
+ final int read = IOUtils.readFully(input, name);
+ trackReadBytes(read);
if (read != nameLen) {
throw new EOFException();
}
@@ -352,15 +371,23 @@ public class ArArchiveInputStream extends ArchiveInputStream {
return GNU_STRING_TABLE_NAME.equals(name);
}
+ private void trackReadBytes(final long read) {
+ count(read);
+ if (read > 0) {
+ offset += read;
+ }
+ }
+
/**
* Reads the GNU archive String Table.
*
* @see #isGNUStringTable
*/
- private ArArchiveEntry readGNUStringTable(final byte[] length) throws IOException {
- final int bufflen = asInt(length); // Assume length will fit in an int
+ private ArArchiveEntry readGNUStringTable(final byte[] length, final int offset, final int len) throws IOException {
+ final int bufflen = asInt(length, offset, len); // Assume length will fit in an int
namebuffer = new byte[bufflen];
- final int read = IOUtils.readFully(this, namebuffer, 0, bufflen);
+ final int read = IOUtils.readFully(input, namebuffer, 0, bufflen);
+ trackReadBytes(read);
if (read != bufflen){
throw new IOException("Failed to read complete // record: expected="
+ bufflen + " read=" + read);
http://git-wip-us.apache.org/repos/asf/commons-compress/blob/ba53647b/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java b/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java
index 6f2d0d5..e665ff9 100644
--- a/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java
+++ b/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java
@@ -83,7 +83,6 @@ public class ArArchiveInputStreamTest extends AbstractTestCase {
}
}
- @org.junit.Ignore("COMPRESS-462")
@Test(expected=IllegalStateException.class)
public void cantReadWithoutOpeningAnEntry() throws Exception {
try (FileInputStream in = new FileInputStream(getFile("bla.ar"));
@@ -92,7 +91,7 @@ public class ArArchiveInputStreamTest extends AbstractTestCase {
}
}
- @Test(expected=java.io.IOException.class)
+ @Test(expected=IllegalStateException.class)
public void cantReadAfterClose() throws Exception {
try (FileInputStream in = new FileInputStream(getFile("bla.ar"));
ArArchiveInputStream archive = new ArArchiveInputStream(in)) {