You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/11/17 19:26:26 UTC

(commons-compress) branch master updated: ExtraField implements Iterable

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git


The following commit(s) were added to refs/heads/master by this push:
     new c3dca5e99 ExtraField implements Iterable<SubField>
c3dca5e99 is described below

commit c3dca5e99793bc60793ca2eabf5f3a63c4b33660
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Nov 17 14:26:21 2024 -0500

    ExtraField implements Iterable<SubField>
    
    - Better class name after reading the spec again
    - Add unit test for edge case
---
 .../{HeaderExtraField.java => ExtraField.java}     | 67 +++++++++++++++-------
 .../gzip/GzipCompressorInputStream.java            |  2 +-
 .../gzip/GzipCompressorOutputStream.java           |  2 +-
 .../compress/compressors/gzip/GzipParameters.java  | 10 ++--
 .../gzip/GzipCompressorOutputStreamTest.java       | 42 ++++++++++----
 5 files changed, 85 insertions(+), 38 deletions(-)

diff --git a/src/main/java/org/apache/commons/compress/compressors/gzip/HeaderExtraField.java b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
similarity index 75%
rename from src/main/java/org/apache/commons/compress/compressors/gzip/HeaderExtraField.java
rename to src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
index 89d28912e..3bf5a8a72 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/HeaderExtraField.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
@@ -21,9 +21,12 @@ package org.apache.commons.compress.compressors.gzip;
 
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Objects;
 
+import org.apache.commons.compress.compressors.gzip.ExtraField.SubField;
+
 /**
  * If the {@code FLG.FEXTRA} bit is set, an "extra field" is present in the header, with total length XLEN bytes. It consists of a series of subfields, each of
  * the form:
@@ -40,7 +43,7 @@ import java.util.Objects;
  * @see <a href="https://datatracker.ietf.org/doc/html/rfc1952">RFC 1952 GZIP File Format Specification</a>
  * @since 1.28.0
  */
-public class HeaderExtraField {
+public class ExtraField implements Iterable<SubField> {
 
     /**
      * If the {@code FLG.FEXTRA} bit is set, an "extra field" is present in the header, with total length XLEN bytes. It consists of a series of subfields, each
@@ -51,6 +54,20 @@ public class HeaderExtraField {
      * |SI1|SI2|  LEN  |... LEN bytes of subfield data ...|
      * +---+---+---+---+==================================+
      * </pre>
+     * <p>
+     * The reserved IDs are:
+     * </p>
+     * <pre>
+     * SI1         SI2         Data
+     * ----------  ----------  ----
+     * 0x41 ('A')  0x70 ('P')  Apollo file type information
+     * </pre>
+     * <p>
+     * Subfield IDs with {@code SI2 = 0} are reserved for future use.
+     * </p>
+     * <p>
+     * LEN gives the length of the subfield data, excluding the 4 initial bytes.
+     * </p>
      *
      * @see <a href="https://datatracker.ietf.org/doc/html/rfc1952">RFC 1952 GZIP File Format Specification</a>
      */
@@ -85,31 +102,31 @@ public class HeaderExtraField {
         }
     }
 
-    static final int MAX_SIZE = 0xFFFF;
+    private static final int MAX_SIZE = 0xFFFF;
 
-    static final byte[] ZERO_BYTES = {};
+    private static final byte[] ZERO_BYTES = {};
 
-    static HeaderExtraField fromBytes(final byte[] ba) throws IOException {
-        if (ba == null) {
+    static ExtraField fromBytes(final byte[] bytes) throws IOException {
+        if (bytes == null) {
             return null;
         }
-        final HeaderExtraField extra = new HeaderExtraField();
+        final ExtraField extra = new ExtraField();
         int pos = 0;
-        while (pos <= ba.length - 4) {
-            final byte si1 = ba[pos++];
-            final byte si2 = ba[pos++];
-            final int sublen = ba[pos++] & 0xff | (ba[pos++] & 0xff) << 8;
-            if (sublen > ba.length - pos) {
-                throw new IOException("Extra subfield lenght exceeds remaining bytes in extra: " + sublen + " > " + (ba.length - pos));
+        while (pos <= bytes.length - 4) {
+            final byte si1 = bytes[pos++];
+            final byte si2 = bytes[pos++];
+            final int sublen = bytes[pos++] & 0xff | (bytes[pos++] & 0xff) << 8;
+            if (sublen > bytes.length - pos) {
+                throw new IOException("Extra subfield lenght exceeds remaining bytes in extra: " + sublen + " > " + (bytes.length - pos));
             }
             final byte[] payload = new byte[sublen];
-            System.arraycopy(ba, pos, payload, 0, sublen);
+            System.arraycopy(bytes, pos, payload, 0, sublen);
             pos += sublen;
             extra.subFields.add(new SubField(si1, si2, payload));
             extra.totalSize = pos;
         }
-        if (pos < ba.length) {
-            throw new IOException("" + (ba.length - pos) + " remaining bytes not used to parse an extra subfield.");
+        if (pos < bytes.length) {
+            throw new IOException("" + (bytes.length - pos) + " remaining bytes not used to parse an extra subfield.");
         }
         return extra;
     }
@@ -121,7 +138,7 @@ public class HeaderExtraField {
     /**
      * Constructs a new instance.
      */
-    public HeaderExtraField() {
+    public ExtraField() {
     }
 
     /**
@@ -132,19 +149,19 @@ public class HeaderExtraField {
      * @return this instance.
      * @throws NullPointerException if {@code id} is {@code null}.
      * @throws NullPointerException if {@code payload} is {@code null}.
-     * @throws IllegalArgumentException if the subfield is not 2-chars or the payload is null
+     * @throws IllegalArgumentException if the subfield is not 2 characters or the payload is null
      * @throws IOException              if appending this subfield would exceed the max size 65535 of the extra header.
      */
-    public HeaderExtraField addSubField(final String id, final byte[] payload) throws IOException {
+    public ExtraField addSubField(final String id, final byte[] payload) throws IOException {
         Objects.requireNonNull(id, "payload");
         Objects.requireNonNull(payload, "payload");
         if (id.length() != 2) {
-            throw new IllegalArgumentException("Subfield id must be a 2-chars ISO-8859-1 string.");
+            throw new IllegalArgumentException("Subfield id must be a 2 character ISO-8859-1 string.");
         }
         final char si1 = id.charAt(0);
         final char si2 = id.charAt(1);
         if ((si1 & 0xff00) != 0 || (si2 & 0xff00) != 0) {
-            throw new IllegalArgumentException("Subfield id must be a 2-chars ISO-8859-1 string.");
+            throw new IllegalArgumentException("Subfield id must be a 2 character ISO-8859-1 string.");
         }
         final SubField f = new SubField((byte) (si1 & 0xff), (byte) (si2 & 0xff), payload);
         final int len = 4 + payload.length;
@@ -167,6 +184,16 @@ public class HeaderExtraField {
         return subFields.get(index);
     }
 
+    /**
+     * Returns an iterator over the SubField elements in this extra field in proper sequence.
+     *
+     * @return an iterator over the SubField elements in this extra field in proper sequence.
+     */
+    @Override
+    public Iterator<SubField> iterator() {
+        return subFields.iterator();
+    }
+
     byte[] toByteArray() {
         if (subFields.isEmpty()) {
             return ZERO_BYTES;
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 63e915bd6..a37f632a3 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
@@ -250,7 +250,7 @@ public class GzipCompressorInputStream extends CompressorInputStream implements
             xlen |= inData.readUnsignedByte() << 8;
             final byte[] extra = new byte[xlen];
             inData.readFully(extra);
-            parameters.setExtra(HeaderExtraField.fromBytes(extra));
+            parameters.setExtraField(ExtraField.fromBytes(extra));
         }
 
         // Original file name
diff --git a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
index 9c23414eb..3c07c12e0 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
@@ -173,7 +173,7 @@ public class GzipCompressorOutputStream extends CompressorOutputStream<OutputStr
     private void writeHeader(final GzipParameters parameters) throws IOException {
         final String fileName = parameters.getFileName();
         final String comment = parameters.getComment();
-        final byte[] extra = parameters.getExtra() != null ? parameters.getExtra().toByteArray() : null;
+        final byte[] extra = parameters.getExtraField() != null ? parameters.getExtraField().toByteArray() : null;
         final ByteBuffer buffer = ByteBuffer.allocate(10);
         buffer.order(ByteOrder.LITTLE_ENDIAN);
         buffer.putShort((short) GZIPInputStream.GZIP_MAGIC);
diff --git a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
index 1eb8a8721..07ce38f26 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
@@ -290,7 +290,7 @@ public class GzipParameters {
      * </p>
      */
     private Instant modificationTime = Instant.EPOCH;
-    private HeaderExtraField extra;
+    private ExtraField extraField;
     private String fileName;
     private Charset fileNameCharset = GzipUtils.GZIP_ENCODING;
     private String comment;
@@ -349,8 +349,8 @@ public class GzipParameters {
      * @return the extra subfields from the header.
      * @since 1.28.0
      */
-    public HeaderExtraField getExtra() {
-        return extra;
+    public ExtraField getExtraField() {
+        return extraField;
     }
 
     /**
@@ -487,8 +487,8 @@ public class GzipParameters {
      * @param extra the series of extra sub fields.
      * @since 1.28.0
      */
-    public void setExtra(final HeaderExtraField extra) {
-        this.extra = extra;
+    public void setExtraField(final ExtraField extra) {
+        this.extraField = extra;
     }
 
     /**
diff --git a/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java b/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java
index 1887978f6..3f7b930fb 100644
--- a/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStreamTest.java
@@ -19,8 +19,11 @@
 
 package org.apache.commons.compress.compressors.gzip;
 
-import static org.junit.Assert.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.fail;
 import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
 import java.io.IOException;
@@ -30,8 +33,9 @@ import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Arrays;
+import java.util.concurrent.atomic.AtomicInteger;
 
-import org.apache.commons.compress.compressors.gzip.HeaderExtraField.SubField;
+import org.apache.commons.compress.compressors.gzip.ExtraField.SubField;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
@@ -104,15 +108,15 @@ public class GzipCompressorOutputStreamTest {
         "2, 32763, false"
     })
     // @formatter:on
-    public void testExtraSubfields(final int subfieldQty, final Integer payloadSize, final boolean shouldFail) throws IOException {
+    public void testExtraSubfields(final int subFieldCount, final Integer payloadSize, final boolean shouldFail) throws IOException {
         final Path tempSourceFile = Files.createTempFile("test_gzip_extra_", ".txt");
         final Path targetFile = Files.createTempFile("test_gzip_extra_", ".txt.gz");
         Files.write(tempSourceFile, "Hello World!".getBytes(StandardCharsets.ISO_8859_1));
         final GzipParameters parameters = new GzipParameters();
-        final HeaderExtraField extra = new HeaderExtraField();
+        final ExtraField extra = new ExtraField();
         boolean failed = false;
-        final byte[][] payloads = new byte[subfieldQty][];
-        for (int i = 0; i < subfieldQty; i++) {
+        final byte[][] payloads = new byte[subFieldCount][];
+        for (int i = 0; i < subFieldCount; i++) {
             if (payloadSize != null) {
                 payloads[i] = new byte[payloadSize];
                 Arrays.fill(payloads[i], (byte) ('a' + i));
@@ -128,22 +132,38 @@ public class GzipCompressorOutputStreamTest {
         if (shouldFail) {
             return;
         }
-        parameters.setExtra(extra);
+        parameters.setExtraField(extra);
         try (OutputStream fos = Files.newOutputStream(targetFile);
                 GzipCompressorOutputStream gos = new GzipCompressorOutputStream(fos, parameters)) {
             Files.copy(tempSourceFile, gos);
         }
         try (GzipCompressorInputStream gis = new GzipCompressorInputStream(Files.newInputStream(targetFile))) {
-            final HeaderExtraField extra2 = gis.getMetaData().getExtra();
-            for (int i = 0; i < subfieldQty; i++) {
+            final ExtraField extra2 = gis.getMetaData().getExtraField();
+            for (int i = 0; i < subFieldCount; i++) {
                 final SubField sf = extra2.getSubFieldAt(i);
                 assertEquals("z" + i, sf.getId()); // id was saved/loaded correctly
-                final byte[] ba = sf.getPayload();
-                assertArrayEquals("field " + i + " has wrong payload", payloads[i], ba);
+                assertArrayEquals(payloads[i], sf.getPayload(), "field " + i + " has wrong payload");
             }
+            final AtomicInteger i = new AtomicInteger();
+            gis.getMetaData().getExtraField().forEach(sf -> {
+                assertEquals("z" + i, sf.getId()); // id was saved/loaded correctly
+                assertArrayEquals(payloads[i.intValue()], sf.getPayload(), "field " + i + " has wrong payload");
+                i.incrementAndGet();
+            });
         }
     }
 
+    @Test
+    public void testExtraSubfieldsEmpty() {
+        final ExtraField extra = new ExtraField();
+        assertEquals(0, extra.toByteArray().length);
+        assertFalse(extra.iterator().hasNext());
+        extra.forEach(e -> {
+            fail("Not emprt");
+        });
+        assertThrows(IndexOutOfBoundsException.class, () -> extra.getSubFieldAt(0));
+    }
+
     private void testFileName(final String expected, final String sourceFile) throws IOException {
         final Path tempSourceFile = Files.createTempFile(sourceFile, sourceFile);
         Files.write(tempSourceFile, "<text>Hello World!</text>".getBytes(StandardCharsets.ISO_8859_1));