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 2bd3634e0b POIXMLDocumentPart: remove child parts that only a removed
part used (#1543)
2bd3634e0b is described below
commit 2bd3634e0b4441a1ae11dc50894dc83fffe3bc05
Author: Nayyar <[email protected]>
AuthorDate: Mon Nov 9 12:01:21 2026 +0530
POIXMLDocumentPart: remove child parts that only a removed part used (#1543)
* remove the parts only used by a removed OOXML part
POIXMLDocumentPart.removeRelation(part, true) removed the target part
once nothing related to it any more, but left that part's own relations
alone. The parts only it used stayed in the package and were written
out: XSSFWorkbook.removeSheetAt left the drawing's charts and pictures,
XMLSlideShow.removeSlide a chart's embedded workbook, SmartArt data,
embedded objects and media.
Release the relations of a removed part too, and remove each child that
no relationship in the package targets any more. The package is checked
because one package part can be represented by several document parts,
e.g. a picture placed on two sheets. removeSlide removes the slide's
relation after its own per-type handling, so that still sees the
slide's relations.
* drop removed pictures from the workbook and slideshow picture lists
Removing a sheet or slide can now delete pictures it alone used, but
XSSFWorkbook.pictures and XMLSlideShow._pictures kept listing them, so
reusing such an entry related a new shape to a part that no longer
exists. Drop the entries whose part is gone after the removal. XSSF's
addPicture no longer assumes the list size matches the highest part
number and looks for a free one instead.
Internal hyperlink relationships keep their target as written, so
resolve a relative target against the source part before comparing.
---
.../org/apache/poi/ooxml/POIXMLDocumentPart.java | 81 +++++++++++++++++++--
.../apache/poi/xslf/usermodel/XMLSlideShow.java | 7 +-
.../apache/poi/xssf/usermodel/XSSFWorkbook.java | 21 ++++--
.../poi/xslf/usermodel/TestXSLFSlideShow.java | 48 +++++++++++++
.../poi/xssf/usermodel/TestXSSFWorkbook.java | 83 ++++++++++++++++++++++
5 files changed, 229 insertions(+), 11 deletions(-)
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java
b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java
index bd56b4bcc2..7d63eb9f59 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/ooxml/POIXMLDocumentPart.java
@@ -29,6 +29,7 @@ import java.util.Set;
import org.apache.logging.log4j.Logger;
import org.apache.poi.logging.PoiLogManager;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
+import org.apache.poi.openxml4j.exceptions.InvalidOperationException;
import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
import org.apache.poi.openxml4j.exceptions.PartAlreadyExistsException;
import org.apache.poi.openxml4j.opc.OPCPackage;
@@ -406,17 +407,85 @@ public class POIXMLDocumentPart {
if (removeUnusedParts) {
/* if last relation to target part was removed, delete according
target part */
if (part.getRelationCounter() == 0) {
- try {
- part.onDocumentRemove();
- } catch (IOException e) {
- throw new POIXMLException(e);
- }
-
getPackagePart().getPackage().removePart(part.getPackagePart());
+ part.removeFromPackage();
}
}
return true;
}
+ /**
+ * Remove this part from the package, together with the parts it relates to
+ * which are not used by any other part
+ */
+ private void removeFromPackage() {
+ try {
+ onDocumentRemove();
+ } catch (IOException e) {
+ throw new POIXMLException(e);
+ }
+ for (RelationPart rp : getRelationParts()) {
+ POIXMLDocumentPart child = rp.getDocumentPart();
+ removeRelation(rp.getRelationship().getId(), false);
+ // the relation counter alone is not enough, as a package part can
be
+ // represented by more than one document part, e.g. a picture on
two sheets
+ if (child.getRelationCounter() == 0 &&
!child.isRelationshipTarget()) {
+ child.removeFromPackage();
+ }
+ }
+ getPackagePart().getPackage().removePart(getPackagePart());
+ }
+
+ /**
+ * @return true, if a relationship of the package or one of its parts
targets this part
+ */
+ private boolean isRelationshipTarget() {
+ OPCPackage pkg = getPackagePart().getPackage();
+ PackagePartName name = getPackagePart().getPartName();
+ try {
+ if (hasTarget(pkg.getRelationships(), name)) {
+ return true;
+ }
+ for (PackagePart pp : pkg.getParts()) {
+ if (!pp.isRelationshipPart() &&
hasTarget(pp.getRelationships(), name)) {
+ return true;
+ }
+ }
+ return false;
+ } catch (InvalidFormatException | InvalidOperationException e) {
+ // keep the part, if the package relationships can't be checked
+ return true;
+ }
+ }
+
+ private static boolean hasTarget(PackageRelationshipCollection rels,
PackagePartName name) {
+ for (PackageRelationship rel : rels) {
+ if (rel.getTargetMode() != TargetMode.INTERNAL) {
+ continue;
+ }
+ URI uri = rel.getTargetURI();
+ String path = uri.getRawPath();
+ if (uri.isAbsolute() || path == null || path.isEmpty()) {
+ // not a part name, or a fragment within the source part
+ continue;
+ }
+ try {
+ // internal hyperlinks keep the target as written, so it can
still be relative
+ if (!path.startsWith("/")) {
+ uri =
PackagingURIHelper.resolvePartUri(rel.getSourceURI(), uri);
+ }
+ PackagePartName target = (uri.getRawFragment() != null)
+ ? PackagingURIHelper.createPartName(uri.getPath())
+ : PackagingURIHelper.createPartName(uri);
+ if (name.equals(target)) {
+ return true;
+ }
+ } catch (InvalidFormatException e) {
+ // not a part name
+ }
+ }
+ return false;
+ }
+
/**
* Returns the parent POIXMLDocumentPart. All parts except root have
not-null parent.
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
index 498282aae6..00f0d36028 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
@@ -503,7 +503,6 @@ public class XMLSlideShow extends POIXMLDocument
*/
public XSLFSlide removeSlide(int index) {
XSLFSlide slide = _slides.remove(index);
- removeRelation(slide);
_presentation.getSldIdLst().removeSldId(index);
for (POIXMLDocumentPart p : slide.getRelations()) {
if (p instanceof XSLFChart chart) {
@@ -519,6 +518,12 @@ public class XMLSlideShow extends POIXMLDocument
_pictures.remove(picture);
}
}
+ // removing the slide also removes the parts which only it used,
+ // so the relations above need to be handled first
+ removeRelation(slide);
+ // the picture list holds its own instances, so drop them by part,
+ // which also covers images reached through other parts, e.g. SmartArt
+ _pictures.removeIf(p ->
!getPackage().containPart(p.getPackagePart().getPartName()));
return slide;
}
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
index 2e06ba6f7c..0bfb949552 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -607,7 +607,7 @@ public class XSSFWorkbook extends POIXMLDocument implements
Workbook, Date1904Su
*/
@Override
public int addPicture(byte[] pictureData, int format) {
- int imageNumber = getAllPictures().size() + 1;
+ int imageNumber = nextPictureNumber(format);
XSSFPictureData img =
createRelationship(XSSFPictureData.getRelationForType(format),
this.xssfFactory, imageNumber, true).getDocumentPart();
try (OutputStream out = img.getPackagePart().getOutputStream()) {
out.write(pictureData);
@@ -615,7 +615,7 @@ public class XSSFWorkbook extends POIXMLDocument implements
Workbook, Date1904Su
throw new POIXMLException(e);
}
pictures.add(img);
- return imageNumber - 1;
+ return pictures.size() - 1;
}
/**
@@ -634,13 +634,21 @@ public class XSSFWorkbook extends POIXMLDocument
implements Workbook, Date1904Su
* @see #getAllPictures()
*/
public int addPicture(InputStream is, int format) throws IOException {
- int imageNumber = getAllPictures().size() + 1;
+ int imageNumber = nextPictureNumber(format);
XSSFPictureData img =
createRelationship(XSSFPictureData.getRelationForType(format),
this.xssfFactory, imageNumber, true).getDocumentPart();
try (OutputStream out = img.getPackagePart().getOutputStream()) {
IOUtils.copy(is, out);
}
pictures.add(img);
- return imageNumber - 1;
+ return pictures.size() - 1;
+ }
+
+ /**
+ * The picture list can have gaps in the part numbers once the pictures
only
+ * a removed sheet used have been dropped, so look for a free one
+ */
+ private int nextPictureNumber(int format) {
+ return getNextPartNumber(XSSFPictureData.getRelationForType(format),
getAllPictures().size() + 1);
}
/**
@@ -1443,6 +1451,11 @@ public class XSSFWorkbook extends POIXMLDocument
implements Workbook, Date1904Su
removeRelation(sheet);
sheets.remove(index);
+ // removing the sheet also removes the pictures only it used
+ if (pictures != null) {
+ pictures.removeIf(p ->
!getPackage().containPart(p.getPackagePart().getPartName()));
+ }
+
// only set new sheet if there are still some left
if(sheets.isEmpty()) {
return;
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlideShow.java
b/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlideShow.java
index a0aee124ff..57ef9e434f 100644
---
a/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlideShow.java
+++
b/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFSlideShow.java
@@ -40,6 +40,7 @@ import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
class TestXSLFSlideShow {
@Test
@@ -274,6 +275,53 @@ class TestXSLFSlideShow {
}
}
+ /**
+ * This test ensures that the parts used by a removed slide's chart and
SmartArt,
+ * i.e. the embedded workbook and the diagram data, are not left orphaned.
+ */
+ @Test
+ void testRemoveSlideThatHasChartAndSmartArt() throws IOException {
+ try (XMLSlideShow ppt =
XSLFTestDataSamples.openSampleDocument("pie-chart.pptx")) {
+ ppt.removeSlide(0);
+ try (XMLSlideShow ppt2 =
XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
+ assertEquals(0,
ppt2.getPackage().getPartsByName(Pattern.compile("/ppt/(charts|embeddings)/.*")).size());
+ }
+ }
+
+ try (XMLSlideShow ppt =
XSLFTestDataSamples.openSampleDocument("smartart-simple.pptx")) {
+ ppt.removeSlide(0);
+ try (XMLSlideShow ppt2 =
XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
+ assertEquals(0,
ppt2.getPackage().getPartsByName(Pattern.compile("/ppt/(diagrams|media)/.*")).size());
+ }
+ }
+ }
+
+ /**
+ * The picture data of the slideshow must not list the pictures removed
together with a slide,
+ * whether they were used through a SmartArt diagram or directly by the
slide.
+ */
+ @Test
+ void testRemoveSlideUpdatesPictureData() throws IOException {
+ try (XMLSlideShow ppt =
XSLFTestDataSamples.openSampleDocument("smartart-simple.pptx")) {
+ // the SmartArt image is the only picture of the deck
+ byte[] data = ppt.getPictureData().get(0).getData();
+ ppt.removeSlide(0);
+ assertTrue(ppt.getPictureData().isEmpty());
+
+ // adding the same image again creates a new part instead of
returning the removed one
+ XSLFPictureData pd = ppt.addPicture(data,
PictureData.PictureType.JPEG);
+ ppt.createSlide().createPicture(pd);
+ try (XMLSlideShow ppt2 =
XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
+ XSLFPictureShape pic = (XSLFPictureShape)
ppt2.getSlides().get(0).getShapes().get(0);
+ assertArrayEquals(data, pic.getPictureData().getData());
+
+ assertEquals(1, ppt2.getPictureData().size());
+ ppt2.removeSlide(0);
+ assertTrue(ppt2.getPictureData().isEmpty());
+ }
+ }
+ }
+
@Test
void testDimension() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java
b/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java
index 4d19af774e..4330228184 100644
---
a/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java
+++
b/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java
@@ -34,7 +34,9 @@ import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackagePartName;
import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.poi.openxml4j.opc.PackageRelationshipCollection;
+import org.apache.poi.openxml4j.opc.PackageRelationshipTypes;
import org.apache.poi.openxml4j.opc.PackagingURIHelper;
+import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.openxml4j.opc.ZipPackage;
import org.apache.poi.openxml4j.opc.internal.FileHelper;
import org.apache.poi.openxml4j.opc.internal.InvalidZipException;
@@ -84,12 +86,14 @@ import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
+import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
+import java.util.regex.Pattern;
import java.util.zip.CRC32;
import static org.apache.poi.POITestCase.assertContains;
@@ -1202,6 +1206,85 @@ public final class TestXSSFWorkbook extends
BaseTestXWorkbook {
wb.close();
}
+ @Test
+ void testRemoveSheetRemovesDrawingParts() throws IOException {
+ try (XSSFWorkbook wb = openSampleWorkbook("WithThreeCharts.xlsx")) {
+ // Sheet2 has two charts, Sheet3 has one
+ wb.removeSheetAt(1);
+ try (XSSFWorkbook wb2 = writeOutAndReadBack(wb)) {
+ assertEquals(1,
wb2.getPackage().getPartsByName(Pattern.compile("/xl/charts/.*")).size());
+ assertEquals(1,
wb2.getSheet("Sheet3").getDrawingPatriarch().getCharts().size());
+ }
+ }
+
+ try (XSSFWorkbook wb = new XSSFWorkbook()) {
+ byte[] shared = {1, 2, 3};
+ byte[] own = {4, 5, 6};
+ int sharedIdx = wb.addPicture(shared, Workbook.PICTURE_TYPE_PNG);
+ int ownIdx = wb.addPicture(own, Workbook.PICTURE_TYPE_PNG);
+ XSSFDrawing dg1 =
wb.createSheet("Sheet1").createDrawingPatriarch();
+ dg1.createPicture(new XSSFClientAnchor(), sharedIdx);
+ dg1.createPicture(new XSSFClientAnchor(), ownIdx);
+
wb.createSheet("Sheet2").createDrawingPatriarch().createPicture(new
XSSFClientAnchor(), sharedIdx);
+
+ wb.removeSheetAt(0);
+ try (XSSFWorkbook wb2 = writeOutAndReadBack(wb)) {
+ // the picture used by the remaining sheet is kept, the other
one is removed
+ assertEquals(1,
wb2.getPackage().getPartsByName(Pattern.compile("/xl/media/.*")).size());
+ XSSFPicture pic = (XSSFPicture)
wb2.getSheetAt(0).getDrawingPatriarch().getShapes().get(0);
+ assertArrayEquals(shared, pic.getPictureData().getData());
+ }
+ }
+ }
+
+ @Test
+ void testRemoveSheetUpdatesPictureList() throws IOException {
+ try (XSSFWorkbook wb = new XSSFWorkbook()) {
+ byte[] removed = {1, 2, 3};
+ byte[] kept = {4, 5, 6};
+ int removedIdx = wb.addPicture(removed, Workbook.PICTURE_TYPE_PNG);
+ int keptIdx = wb.addPicture(kept, Workbook.PICTURE_TYPE_PNG);
+
wb.createSheet("Template").createDrawingPatriarch().createPicture(new
XSSFClientAnchor(), removedIdx);
+ XSSFDrawing other =
wb.createSheet("Other").createDrawingPatriarch();
+ other.createPicture(new XSSFClientAnchor(), keptIdx);
+
+ wb.removeSheetAt(wb.getSheetIndex("Template"));
+ // the picture only the removed sheet used is no longer listed
+ assertEquals(1, wb.getAllPictures().size());
+ assertArrayEquals(kept, wb.getAllPictures().get(0).getData());
+
+ // the remaining part names don't follow the list any more, so a
new picture needs a free one
+ assertEquals(1, wb.addPicture(removed, Workbook.PICTURE_TYPE_PNG));
+ for (int i = 0; i < wb.getAllPictures().size(); i++) {
+ other.createPicture(new XSSFClientAnchor(), i);
+ }
+
+ try (XSSFWorkbook wb2 = writeOutAndReadBack(wb)) {
+ assertEquals(2,
wb2.getPackage().getPartsByName(Pattern.compile("/xl/media/.*")).size());
+ List<XSSFShape> shapes =
wb2.getSheetAt(0).getDrawingPatriarch().getShapes();
+ assertEquals(3, shapes.size());
+ assertArrayEquals(kept, ((XSSFPicture)
shapes.get(0)).getPictureData().getData());
+ assertArrayEquals(kept, ((XSSFPicture)
shapes.get(1)).getPictureData().getData());
+ assertArrayEquals(removed, ((XSSFPicture)
shapes.get(2)).getPictureData().getData());
+ }
+ }
+ }
+
+ @Test
+ void testRemoveSheetKeepsPartTargetedByRelativeHyperlink() throws
Exception {
+ try (XSSFWorkbook wb = new XSSFWorkbook()) {
+ int idx = wb.addPicture(new byte[]{1, 2, 3},
Workbook.PICTURE_TYPE_PNG);
+ PackagePartName image =
wb.getAllPictures().get(idx).getPackagePart().getPartName();
+
wb.createSheet("Sheet1").createDrawingPatriarch().createPicture(new
XSSFClientAnchor(), idx);
+ // internal hyperlinks keep their target as written, here relative
to the sheet
+ wb.createSheet("Sheet2").getPackagePart().addRelationship(
+ new URI("../media/image1.png"), TargetMode.INTERNAL,
PackageRelationshipTypes.HYPERLINK_PART);
+
+ wb.removeSheetAt(0);
+ assertTrue(wb.getPackage().containPart(image));
+ }
+ }
+
/**
* See bug #61700
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]