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

pjfanning pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/poi.git


The following commit(s) were added to refs/heads/trunk by this push:
     new c59c219f5e Replace asserts on API arguments with real checks (#1558)
c59c219f5e is described below

commit c59c219f5ec3e68648f5ae1bd921d98764f84e55
Author: PJ Fanning <[email protected]>
AuthorDate: Mon Nov 9 13:20:11 2026 +0100

    Replace asserts on API arguments with real checks (#1558)
    
    - XSSFSheet.removeMergedRegion throws IllegalArgumentException for an
      index outside the merged regions. Before, a single merged region was
      removed whatever the index, and with more regions XmlBeans threw an
      IndexOutOfBoundsException.
    - XSLFSlide.setNotes throws UnsupportedOperationException like the
      other unimplemented XSLFSlide setters, instead of doing nothing.
    - TextSpecInfoAtom.setParentSize, EscherColorRef(byte[], int, int) and
      SprmUtils.addSprm throw IllegalArgumentException for a size that
      isn't positive, a length other than 4 or 6, and a missing variable
      length parameter.
    - HSLFSlideShowEncrypted.addEncryptionRecord checks its atom with
      Objects.requireNonNull.
    
    Part of #1556
    
    Co-authored-by: Claude Opus 5.5 <[email protected]>
---
 .../org/apache/poi/xslf/usermodel/XSLFSlide.java   |  8 ++++--
 .../org/apache/poi/xssf/usermodel/XSSFSheet.java   |  6 ++++-
 .../apache/poi/xslf/usermodel/TestXSLFSlide.java   | 10 ++++++++
 .../apache/poi/xssf/usermodel/TestXSSFSheet.java   | 20 +++++++++++++++
 .../apache/poi/hslf/record/TextSpecInfoAtom.java   |  7 +++++-
 .../poi/hslf/usermodel/HSLFSlideShowEncrypted.java |  3 ++-
 .../java/org/apache/poi/hwpf/sprm/SprmUtils.java   |  4 ++-
 .../poi/hslf/record/TestTextSpecInfoAtom.java      |  9 +++++++
 .../hslf/usermodel/TestHSLFSlideShowEncrypted.java |  6 +++++
 .../sprm/TestSprmUtils.java}                       | 29 ++++++++++++++--------
 .../java/org/apache/poi/ddf/EscherColorRef.java    | 10 +++++++-
 .../org/apache/poi/ddf/TestEscherColorRef.java     | 24 ++++++++++--------
 12 files changed, 109 insertions(+), 27 deletions(-)

diff --git 
a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java 
b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
index 1fb3d7855a..cf04015a4c 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XSLFSlide.java
@@ -381,11 +381,15 @@ implements Slide<XSLFShape,XSLFTextParagraph> {
         throw new UnsupportedOperationException();
     }
 
+    /**
+     * This method is not yet supported.
+     *
+     * @throws UnsupportedOperationException this method is not yet supported
+     */
     @Override
     @NotImplemented
     public void setNotes(Notes<XSLFShape,XSLFTextParagraph> notes) {
-        assert(notes instanceof XSLFNotes);
-        // TODO Auto-generated method stub
+        throw new UnsupportedOperationException();
     }
 
     @Override
diff --git 
a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java 
b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
index 5b67ff1011..b443d97331 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -1967,6 +1967,7 @@ public class XSSFSheet extends POIXMLDocumentPart 
implements Sheet, OoxmlSheetEx
      * Removes a merged region of cells (hence letting them free)
      *
      * @param index of the region to unmerge
+     * @throws IllegalArgumentException if the sheet has merged regions, but 
none at {@code index}
      */
     @Override
     public void removeMergedRegion(int index) {
@@ -1976,7 +1977,10 @@ public class XSSFSheet extends POIXMLDocumentPart 
implements Sheet, OoxmlSheetEx
 
         CTMergeCells ctMergeCells = worksheet.getMergeCells();
         int size = ctMergeCells.sizeOfMergeCellArray();
-        assert(0 <= index && index < size);
+        if (index < 0 || index >= size) {
+            throw new IllegalArgumentException("Specified merged region index 
" + index
+                    + " is outside the allowable range (0.." + (size - 1) + 
")");
+        }
         if (size > 1) {
             ctMergeCells.removeMergeCell(index);
             ctMergeCells.setCount(ctMergeCells.getCount() - 1);
diff --git 
a/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlide.java 
b/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlide.java
index e475b95ab3..ac0a3191a8 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlide.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlide.java
@@ -23,6 +23,7 @@ import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.awt.Color;
@@ -209,4 +210,13 @@ class TestXSLFSlide {
 
         ppt.close();
     }
+
+    @Test
+    void setNotesIsNotSupported() throws IOException {
+        try (XMLSlideShow ppt = new XMLSlideShow()) {
+            XSLFSlide slide = ppt.createSlide();
+            XSLFNotes notes = ppt.getNotesSlide(slide);
+            assertThrows(UnsupportedOperationException.class, () -> 
slide.setNotes(notes));
+        }
+    }
 }
diff --git 
a/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFSheet.java 
b/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFSheet.java
index 29dadb5b0d..4fce70c7ab 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFSheet.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFSheet.java
@@ -2476,4 +2476,24 @@ public final class TestXSSFSheet extends BaseTestXSheet {
             assertEquals("2-1,2-1,1+2,2-1,2-1,3+3,3+3,3+3,2-1,2-1,", 
sb.toString());
         }
     }
+
+    @Test
+    void removeMergedRegionOutOfRange() throws IOException {
+        try (XSSFWorkbook wb = new XSSFWorkbook()) {
+            XSSFSheet sheet = wb.createSheet();
+            // without merged regions there is nothing to remove
+            sheet.removeMergedRegion(1);
+
+            sheet.addMergedRegion(CellRangeAddress.valueOf("A1:B2"));
+            IllegalArgumentException ex = 
assertThrows(IllegalArgumentException.class, () -> sheet.removeMergedRegion(1));
+            assertEquals("Specified merged region index 1 is outside the 
allowable range (0..0)", ex.getMessage());
+            // the only region was removed for any index before
+            assertEquals(1, sheet.getNumMergedRegions());
+
+            sheet.addMergedRegion(CellRangeAddress.valueOf("C3:D4"));
+            assertThrows(IllegalArgumentException.class, () -> 
sheet.removeMergedRegion(-1));
+            assertThrows(IllegalArgumentException.class, () -> 
sheet.removeMergedRegion(2));
+            assertEquals(2, sheet.getNumMergedRegions());
+        }
+    }
 }
diff --git 
a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/TextSpecInfoAtom.java 
b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/TextSpecInfoAtom.java
index 2734367083..86e7821a2d 100644
--- 
a/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/TextSpecInfoAtom.java
+++ 
b/poi-scratchpad/src/main/java/org/apache/poi/hslf/record/TextSpecInfoAtom.java
@@ -125,9 +125,14 @@ public final class TextSpecInfoAtom extends RecordAtom {
     /**
      * Adapts the size by enlarging the last {@link TextSpecInfoRun}
      * or chopping the runs to the given length
+     *
+     * @param size the new length, which must be positive
+     * @throws IllegalArgumentException if {@code size} isn't positive
      */
     public void setParentSize(int size) {
-        assert(size > 0);
+        if (size <= 0) {
+            throw new IllegalArgumentException("Size must be positive, but was 
" + size);
+        }
 
         try (UnsynchronizedByteArrayOutputStream bos = 
UnsynchronizedByteArrayOutputStream.builder().get()) {
             TextSpecInfoRun[] runs = getTextSpecInfoRuns();
diff --git 
a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShowEncrypted.java
 
b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShowEncrypted.java
index 7dd121c7f6..905f6dc932 100644
--- 
a/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShowEncrypted.java
+++ 
b/poi-scratchpad/src/main/java/org/apache/poi/hslf/usermodel/HSLFSlideShowEncrypted.java
@@ -25,6 +25,7 @@ import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.NavigableMap;
+import java.util.Objects;
 import java.util.TreeMap;
 
 import org.apache.poi.EncryptedDocumentException;
@@ -553,7 +554,7 @@ public class HSLFSlideShowEncrypted implements Closeable {
 
 
     protected static org.apache.poi.hslf.record.Record[] 
addEncryptionRecord(org.apache.poi.hslf.record.Record[] records, 
DocumentEncryptionAtom dea) {
-        assert(dea != null);
+        Objects.requireNonNull(dea, "dea");
         int ueaIdx = -1, ptrIdx = -1, deaIdx = -1, idx = -1;
         for (org.apache.poi.hslf.record.Record r : records) {
             idx++;
diff --git 
a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/sprm/SprmUtils.java 
b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/sprm/SprmUtils.java
index 65340cd527..c086372c38 100644
--- a/poi-scratchpad/src/main/java/org/apache/poi/hwpf/sprm/SprmUtils.java
+++ b/poi-scratchpad/src/main/java/org/apache/poi/hwpf/sprm/SprmUtils.java
@@ -87,7 +87,9 @@ public final class SprmUtils {
                 LittleEndian.putShort(sprm, 2, (short)param);
                 break;
             case 6:
-                assert(varParam != null);
+                if (varParam == null) {
+                    throw new IllegalArgumentException("A variable length sprm 
needs varParam");
+                }
                 sprm = new byte[3 + varParam.length];
                 sprm[2] = (byte)varParam.length;
                 System.arraycopy(varParam, 0, sprm, 3, varParam.length);
diff --git 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/record/TestTextSpecInfoAtom.java
 
b/poi-scratchpad/src/test/java/org/apache/poi/hslf/record/TestTextSpecInfoAtom.java
index 8902d31882..caaa52fbee 100644
--- 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/record/TestTextSpecInfoAtom.java
+++ 
b/poi-scratchpad/src/test/java/org/apache/poi/hslf/record/TestTextSpecInfoAtom.java
@@ -19,6 +19,7 @@ package org.apache.poi.hslf.record;
 
 import static org.junit.jupiter.api.Assertions.assertArrayEquals;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream;
 import org.junit.jupiter.api.Test;
@@ -79,4 +80,12 @@ public final class TestTextSpecInfoAtom  {
 
         assertEquals(32, run2[0].getLength());
     }
+
+    @Test
+    void testSetParentSizeNotPositive() {
+        TextSpecInfoAtom spec = new TextSpecInfoAtom(data_1, 0, data_1.length);
+        assertThrows(IllegalArgumentException.class, () -> 
spec.setParentSize(0));
+        assertThrows(IllegalArgumentException.class, () -> 
spec.setParentSize(-1));
+        assertEquals(5, spec.getTextSpecInfoRuns().length);
+    }
 }
diff --git 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
 
b/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
index 55ffb2ea06..3bccd50831 100644
--- 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
+++ 
b/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
@@ -33,4 +33,10 @@ class TestHSLFSlideShowEncrypted {
         assertThrows(CorruptPowerPointFileException.class,
             () -> HSLFSlideShowEncrypted.addEncryptionRecord(records, new 
DocumentEncryptionAtom()));
     }
+
+    @Test
+    void addEncryptionRecordNeedsAtom() {
+        assertThrows(NullPointerException.class,
+            () -> HSLFSlideShowEncrypted.addEncryptionRecord(new Record[0], 
null));
+    }
 }
diff --git 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
 b/poi-scratchpad/src/test/java/org/apache/poi/hwpf/sprm/TestSprmUtils.java
similarity index 56%
copy from 
poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
copy to poi-scratchpad/src/test/java/org/apache/poi/hwpf/sprm/TestSprmUtils.java
index 55ffb2ea06..5b362ae457 100644
--- 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
+++ b/poi-scratchpad/src/test/java/org/apache/poi/hwpf/sprm/TestSprmUtils.java
@@ -15,22 +15,31 @@
    limitations under the License.
 ==================================================================== */
 
-package org.apache.poi.hslf.usermodel;
+package org.apache.poi.hwpf.sprm;
 
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
-import org.apache.poi.hslf.exceptions.CorruptPowerPointFileException;
-import org.apache.poi.hslf.record.DocumentEncryptionAtom;
-import org.apache.poi.hslf.record.Record;
+import java.util.ArrayList;
+import java.util.List;
+
 import org.junit.jupiter.api.Test;
 
-class TestHSLFSlideShowEncrypted {
+class TestSprmUtils {
+
+    @Test
+    void addVariableLengthSprm() {
+        List<byte[]> list = new ArrayList<>();
+        // type 6 (0xD202) has a variable length parameter
+        assertEquals(5, SprmUtils.addSprm((short) 0xD202, 0, new byte[]{1, 2}, 
list));
+        assertArrayEquals(new byte[]{0x02, (byte) 0xD2, 2, 1, 2}, list.get(0));
+    }
 
     @Test
-    void addEncryptionRecordNeedsPersistRecords() {
-        // without a PersistPtrHolder and UserEditAtom there is nowhere to add 
the encryption record
-        Record[] records = new Record[0];
-        assertThrows(CorruptPowerPointFileException.class,
-            () -> HSLFSlideShowEncrypted.addEncryptionRecord(records, new 
DocumentEncryptionAtom()));
+    void variableLengthSprmNeedsParameter() {
+        List<byte[]> list = new ArrayList<>();
+        assertThrows(IllegalArgumentException.class, () -> 
SprmUtils.addSprm((short) 0xD202, 0, null, list));
+        assertEquals(0, list.size());
     }
 }
diff --git a/poi/src/main/java/org/apache/poi/ddf/EscherColorRef.java 
b/poi/src/main/java/org/apache/poi/ddf/EscherColorRef.java
index 0603329b18..9e9e5f2ba4 100644
--- a/poi/src/main/java/org/apache/poi/ddf/EscherColorRef.java
+++ b/poi/src/main/java/org/apache/poi/ddf/EscherColorRef.java
@@ -166,8 +166,16 @@ public class EscherColorRef {
         this.colorRef = colorRef;
     }
     
+    /**
+     * @param source the data to read the color from
+     * @param start the offset of the color in {@code source}
+     * @param len 4 for just the color, or 6 if it is preceded by an opid
+     * @throws IllegalArgumentException if {@code len} is neither 4 nor 6
+     */
     public EscherColorRef(byte[] source, int start, int len) {
-        assert(len == 4 || len == 6);
+        if (len != 4 && len != 6) {
+            throw new IllegalArgumentException("Length must be 4 or 6, but was 
" + len);
+        }
         
         int offset = start;
         if (len == 6) {
diff --git 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
 b/poi/src/test/java/org/apache/poi/ddf/TestEscherColorRef.java
similarity index 63%
copy from 
poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
copy to poi/src/test/java/org/apache/poi/ddf/TestEscherColorRef.java
index 55ffb2ea06..4c0892cf8c 100644
--- 
a/poi-scratchpad/src/test/java/org/apache/poi/hslf/usermodel/TestHSLFSlideShowEncrypted.java
+++ b/poi/src/test/java/org/apache/poi/ddf/TestEscherColorRef.java
@@ -15,22 +15,26 @@
    limitations under the License.
 ==================================================================== */
 
-package org.apache.poi.hslf.usermodel;
+package org.apache.poi.ddf;
 
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
-import org.apache.poi.hslf.exceptions.CorruptPowerPointFileException;
-import org.apache.poi.hslf.record.DocumentEncryptionAtom;
-import org.apache.poi.hslf.record.Record;
 import org.junit.jupiter.api.Test;
 
-class TestHSLFSlideShowEncrypted {
+class TestEscherColorRef {
 
     @Test
-    void addEncryptionRecordNeedsPersistRecords() {
-        // without a PersistPtrHolder and UserEditAtom there is nowhere to add 
the encryption record
-        Record[] records = new Record[0];
-        assertThrows(CorruptPowerPointFileException.class,
-            () -> HSLFSlideShowEncrypted.addEncryptionRecord(records, new 
DocumentEncryptionAtom()));
+    void readColor() {
+        byte[] data = {0x10, 0x20, 0x30, 0x00};
+        EscherColorRef ref = new EscherColorRef(data, 0, 4);
+        assertArrayEquals(new int[]{0x10, 0x20, 0x30}, ref.getRGB());
+    }
+
+    @Test
+    void rejectsOtherLengths() {
+        byte[] data = new byte[8];
+        assertThrows(IllegalArgumentException.class, () -> new 
EscherColorRef(data, 0, 5));
+        assertThrows(IllegalArgumentException.class, () -> new 
EscherColorRef(data, 0, 8));
     }
 }


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to