poi/poi-ooxml/src/test/java/org/apache/poi/xslf/usermodel/TestXSLFPictureShape.java

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */
package org.apache.poi.xslf.usermodel;

import static org.apache.poi.xslf.XSLFTestDataSamples.openSampleDocument;
import static org.apache.poi.xslf.XSLFTestDataSamples.writeOutAndReadBack;
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.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assumptions.assumeFalse;

import java.awt.geom.Rectangle2D;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.imageio.IIOException;

import org.apache.poi.POIDataSamples;
import org.apache.poi.sl.usermodel.PictureData.PictureType;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.TempFile;
import org.apache.poi.xslf.util.PPTX2PNG;
import org.junit.jupiter.api.Test;
import org.openxmlformats.schemas.presentationml.x2006.main.CTPicture;

class TestXSLFPictureShape {
    private static final POIDataSamples _slTests = POIDataSamples.getSlideShowInstance();

    @Test
    void testCreate() throws Exception {
        try (XMLSlideShow ppt1 = new XMLSlideShow()) {
            assertEquals(0, ppt1.getPictureData().size());
            byte[] data1 = new byte[100];
            for (int i = 0; i < 100; i++) {
                data1[i] = (byte) i;
            }
            XSLFPictureData pdata1 = ppt1.addPicture(data1, PictureType.JPEG);
            assertEquals(0, pdata1.getIndex());
            assertEquals(1, ppt1.getPictureData().size());

            XSLFSlide slide = ppt1.createSlide();
            XSLFPictureShape shape1 = slide.createPicture(pdata1);
            assertNotNull(shape1.getPictureData());
            assertArrayEquals(data1, shape1.getPictureData().getData());

            byte[] data2 = new byte[200];
            for (int i = 0; i < 200; i++) {
                data2[i] = (byte) i;
            }
            XSLFPictureData pdata2 = ppt1.addPicture(data2, PictureType.PNG);
            XSLFPictureShape shape2 = slide.createPicture(pdata2);
            assertNotNull(shape2.getPictureData());
            assertEquals(1, pdata2.getIndex());
            assertEquals(2, ppt1.getPictureData().size());
            assertArrayEquals(data2, shape2.getPictureData().getData());

            try (XMLSlideShow ppt2 = writeOutAndReadBack(ppt1)) {
                List<XSLFPictureData> pics = ppt2.getPictureData();
                assertEquals(2, pics.size());
                assertArrayEquals(data1, pics.get(0).getData());
                assertArrayEquals(data2, pics.get(1).getData());

                List<XSLFShape> shapes = ppt2.getSlides().get(0).getShapes();
                assertEquals(2, shapes.size());
                XSLFPictureShape xlsfShape0 = (XSLFPictureShape) shapes.get(0);
                XSLFPictureShape xlsfShape1 = (XSLFPictureShape) shapes.get(1);
                assertArrayEquals(data1, xlsfShape0.getPictureData().getData());
                assertArrayEquals(data2, xlsfShape1.getPictureData().getData());
                assertEquals("Picture 2", xlsfShape0.getName());
                assertEquals("Picture 3", xlsfShape1.getName());
            }
        }
    }

    @Test
    void testCreateWithSetName() throws Exception {
        try (XMLSlideShow ppt1 = new XMLSlideShow()) {
            assertEquals(0, ppt1.getPictureData().size());
            byte[] data1 = new byte[100];
            for (int i = 0; i < 100; i++) {
                data1[i] = (byte) i;
            }
            XSLFPictureData pdata1 = ppt1.addPicture(data1, PictureType.JPEG);
            assertEquals(0, pdata1.getIndex());
            assertEquals(1, ppt1.getPictureData().size());

            XSLFSlide slide = ppt1.createSlide();
            XSLFPictureShape shape1 = slide.createPicture(pdata1);
            assertNotNull(shape1.getPictureData());
            assertArrayEquals(data1, shape1.getPictureData().getData());
            assertTrue(shape1.setName("Shape1 Picture"));

            byte[] data2 = new byte[200];
            for (int i = 0; i < 200; i++) {
                data2[i] = (byte) i;
            }
            XSLFPictureData pdata2 = ppt1.addPicture(data2, PictureType.PNG);
            XSLFPictureShape shape2 = slide.createPicture(pdata2);
            assertNotNull(shape2.getPictureData());
            assertEquals(1, pdata2.getIndex());
            assertEquals(2, ppt1.getPictureData().size());
            assertArrayEquals(data2, shape2.getPictureData().getData());
            assertTrue(shape2.setName("Shape2 Picture"));

            try (XMLSlideShow ppt2 = writeOutAndReadBack(ppt1)) {
                List<XSLFPictureData> pics = ppt2.getPictureData();
                assertEquals(2, pics.size());
                assertArrayEquals(data1, pics.get(0).getData());
                assertArrayEquals(data2, pics.get(1).getData());

                List<XSLFShape> shapes = ppt2.getSlides().get(0).getShapes();
                assertEquals(2, shapes.size());
                XSLFPictureShape xlsfShape1 = (XSLFPictureShape) shapes.get(0);
                XSLFPictureShape xlsfShape2 = (XSLFPictureShape) shapes.get(1);
                assertArrayEquals(data1, xlsfShape1.getPictureData().getData());
                assertArrayEquals(data2, xlsfShape2.getPictureData().getData());
                assertEquals("Shape1 Picture", xlsfShape1.getName());
                assertEquals("Shape2 Picture", xlsfShape2.getName());
            }
        }
    }

    @Test
    void testCreateMultiplePictures() throws Exception {
        try (XMLSlideShow ppt1 = new XMLSlideShow()) {
            XSLFSlide slide1 = ppt1.createSlide();
            XSLFGroupShape group1 = slide1.createGroup();


            int pictureIndex = 0;
            // first add 20 images to the slide
            for (int i = 0; i < 20; i++, pictureIndex++) {
                byte[] data = new byte[]{(byte) pictureIndex};
                XSLFPictureData elementData = ppt1.addPicture(data, PictureType.PNG);
                assertEquals(pictureIndex, elementData.getIndex());   // added images have indexes 0,1,2....19
                XSLFPictureShape picture = slide1.createPicture(elementData);
                // POI saves images as image1.png, image2.png, etc.
                String fileName = "image" + (elementData.getIndex() + 1) + ".png";
                assertEquals(fileName, picture.getPictureData().getFileName());
                assertArrayEquals(data, picture.getPictureData().getData());
            }

            // and then add next 20 images to a group
            for (int i = 0; i < 20; i++, pictureIndex++) {
                byte[] data = new byte[]{(byte) pictureIndex};
                XSLFPictureData elementData = ppt1.addPicture(data, PictureType.PNG);
                XSLFPictureShape picture = group1.createPicture(elementData);
                // POI saves images as image1.png, image2.png, etc.
                assertEquals(pictureIndex, elementData.getIndex());   // added images have indexes 0,1,2....19
                String fileName = "image" + (pictureIndex + 1) + ".png";
                assertEquals(fileName, picture.getPictureData().getFileName());
                assertArrayEquals(data, picture.getPictureData().getData());
            }

            // serialize, read back and check that all images are there

            try (XMLSlideShow ppt2 = writeOutAndReadBack(ppt1)) {
                // pictures keyed by file name
                Map<String, XSLFPictureData> pics = new HashMap<>();
                for (XSLFPictureData p : ppt2.getPictureData()) {
                    pics.put(p.getFileName(), p);
                }
                assertEquals(40, pics.size());
                for (int i = 0; i < 40; i++) {
                    byte[] data1 = new byte[]{(byte) i};
                    String fileName = "image" + (i + 1) + ".png";
                    XSLFPictureData data = pics.get(fileName);
                    assertNotNull(data);
                    assertEquals(fileName, data.getFileName());
                    assertArrayEquals(data1, data.getData());
                }
            }
        }
    }

    @Test
    void testImageCaching() throws Exception {
        try (XMLSlideShow ppt = new XMLSlideShow()) {
            byte[] img1 = new byte[]{1, 2, 3};
            byte[] img2 = new byte[]{3, 4, 5};
            XSLFPictureData pdata1 = ppt.addPicture(img1, PictureType.PNG);
            assertEquals(0, pdata1.getIndex());
            assertEquals(0, ppt.addPicture(img1, PictureType.PNG).getIndex());

            XSLFPictureData idx2 = ppt.addPicture(img2, PictureType.PNG);
            assertEquals(1, idx2.getIndex());
            assertEquals(1, ppt.addPicture(img2, PictureType.PNG).getIndex());

            XSLFSlide slide1 = ppt.createSlide();
            assertNotNull(slide1);
            XSLFSlide slide2 = ppt.createSlide();
            assertNotNull(slide2);
        }
    }

    @Test
    void testMerge() throws Exception {
        try (XMLSlideShow ppt1 = new XMLSlideShow()) {
            byte[] data1 = new byte[100];
            XSLFPictureData pdata1 = ppt1.addPicture(data1, PictureType.JPEG);

            XSLFSlide slide1 = ppt1.createSlide();
            XSLFPictureShape shape1 = slide1.createPicture(pdata1);
            CTPicture ctPic1 = (CTPicture) shape1.getXmlObject();
            ctPic1.getNvPicPr().getNvPr().addNewCustDataLst().addNewTags().setId("rId99");

            XSLFPictureShape shape2 = slide1.createPicture(pdata1);
            CTPicture ctPic2 = (CTPicture) shape2.getXmlObject();
            ctPic2.getNvPicPr().getNvPr().addNewCustDataLst().addNewTags().setId("rId99");

            differentShapeName(shape1, shape2);

            XSLFGroupShape group = slide1.createGroup();
            XSLFTextBox tb1 = group.createTextBox();
            XSLFTextBox tb2 = group.createTextBox();

            differentShapeName(tb1, tb2);

            try (XMLSlideShow pptCopy = new XMLSlideShow()) {
                XSLFSlide slideCopy = pptCopy.createSlide().importContent(slide1);
                XSLFPictureShape shapeCopy1 = (XSLFPictureShape) slideCopy.getShapes().get(0);

                assertArrayEquals(data1, shapeCopy1.getPictureData().getData());
                assertEquals(shape1.getShapeName(), shapeCopy1.getShapeName());

                CTPicture ctPicCopy1 = (CTPicture) shapeCopy1.getXmlObject();
                assertFalse(ctPicCopy1.getNvPicPr().getNvPr().isSetCustDataLst());

                XSLFPictureShape shapeCopy2 = (XSLFPictureShape) slideCopy.getShapes().get(1);

                assertArrayEquals(data1, shapeCopy2.getPictureData().getData());
                assertEquals(shape2.getShapeName(), shapeCopy2.getShapeName());

                CTPicture ctPicCopy2 = (CTPicture) shapeCopy2.getXmlObject();
                assertFalse(ctPicCopy2.getNvPicPr().getNvPr().isSetCustDataLst());

                differentShapeName(shapeCopy1, shapeCopy2);

                XSLFGroupShape groupCopy = (XSLFGroupShape) slideCopy.getShapes().get(2);
                XSLFTextBox tbCopy1 = (XSLFTextBox) groupCopy.getShapes().get(0);
                XSLFTextBox tbCopy2 = (XSLFTextBox) groupCopy.getShapes().get(1);

                assertEquals(group.getShapeName(), groupCopy.getShapeName());
                assertEquals(tb1.getShapeName(), tbCopy1.getShapeName());
                assertEquals(tb2.getShapeName(), tbCopy2.getShapeName());

                differentShapeName(tb1, tb2);
            }
        }
    }

    private void differentShapeName(XSLFShape shape1, XSLFShape shape2) {
        assertNotEquals(shape1.getShapeName(), shape2.getShapeName(),
            "We should have different names now, but had: " + shape1.getShapeName() + " for both");
    }

    @Test
    void bug58663() throws IOException {
        try (XMLSlideShow ppt = openSampleDocument("shapes.pptx")) {
            XSLFSlide slide = ppt.getSlides().get(0);
            XSLFPictureShape ps = (XSLFPictureShape) slide.getShapes().get(3);
            slide.removeShape(ps);

            try (XMLSlideShow ppt2 = writeOutAndReadBack(ppt)) {
                assertTrue(ppt2.getPictureData().isEmpty());
            }
        }
    }

    @Test
    void testTiffImageBug59742() throws Exception {
        try (XMLSlideShow slideShow = new XMLSlideShow();
            InputStream tiffStream = _slTests.openResourceAsStream("testtiff.tif")) {
            final byte[] pictureData = IOUtils.toByteArray(tiffStream);

            XSLFPictureData pic = slideShow.addPicture(pictureData, PictureType.TIFF);
            assertEquals("image/tiff", pic.getContentType());
            assertEquals("image1.tiff", pic.getFileName());
        }
    }


    @Test
    void renderSvgImage() throws Exception {
        try (XMLSlideShow ppt = new XMLSlideShow()) {
            XSLFSlide slide = ppt.createSlide();

            try {
                XSLFPictureData svgPic = ppt.addPicture(POIDataSamples.getDocumentInstance().getFile("../project-header.svg"), PictureType.SVG);
                XSLFPictureShape shape = XSLFPictureShape.addSvgImage(slide, svgPic, PictureType.JPEG, null);

                Rectangle2D anchor = shape.getAnchor();
                anchor.setRect(100, 100, anchor.getWidth(), anchor.getHeight());
                shape.setAnchor(anchor);

                assertNotNull(shape.getSvgImage());

                final File tmpFile = TempFile.createTempFile("svgtest", ".pptx");
                System.out.println(tmpFile);
                try (FileOutputStream fos = new FileOutputStream(tmpFile)) {
                    ppt.write(fos);
                }

                String[] args = {
                    "-format", "png", // png,gif,jpg or null for test
                    "-slide", "-1", // -1 for all
                    "-outdir", tmpFile.getParentFile().getCanonicalPath(),
                    "-quiet",
                    tmpFile.getAbsolutePath()
                };
                PPTX2PNG.main(args);
            } catch (IIOException ignored) {
                // Ignore all ImageIO related exceptions like "Can't create output stream!"
                // which fail often in maven builds because of missing/wrong temp directory
            } catch (NoClassDefFoundError ignored) {
                assumeFalse(true, "Batik doesn't work on th module-path");
            }
        }
    }

    @Test
    void testIsSetVideoFile() throws IOException {
        try (XMLSlideShow ppt = openSampleDocument("EmbeddedVideo.pptx")) {
            XSLFSlide slide = ppt.getSlides().get(0);
            XSLFPictureShape ps = (XSLFPictureShape) slide.getShapes().get(0);

            assertTrue(ps.isVideoFile());
        }
    }

    @Test
    void testGetVideoLink() throws IOException {
        try (XMLSlideShow ppt = openSampleDocument("EmbeddedVideo.pptx")) {
            XSLFSlide slide = ppt.getSlides().get(0);
            XSLFPictureShape ps = (XSLFPictureShape) slide.getShapes().get(0);

            assertEquals(ps.getVideoFileLink(), "rId2");
        }
    }
}