/* ==================================================================== 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.hslf.usermodel; import static org.apache.poi.hslf.HSLFTestDataSamples.getSlideShow; import static org.apache.poi.hslf.HSLFTestDataSamples.writeOutAndReadBack; import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.junit.jupiter.api.Assertions.fail; import java.awt.Dimension; import java.awt.geom.Dimension2D; import java.awt.image.BufferedImage; import java.io.ByteArrayInputStream; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import java.net.URL; import java.util.Arrays; import java.util.Collections; import java.util.List; import javax.imageio.ImageIO; import org.apache.commons.io.output.CountingOutputStream; import org.apache.commons.io.output.NullOutputStream; import org.apache.poi.POIDataSamples; import org.apache.poi.ddf.EscherBSERecord; import org.apache.poi.ddf.EscherContainerRecord; import org.apache.poi.ddf.EscherRecord; import org.apache.poi.hslf.blip.EMF; import org.apache.poi.hslf.blip.JPEG; import org.apache.poi.hslf.blip.PICT; import org.apache.poi.hslf.blip.PNG; import org.apache.poi.hslf.blip.WMF; import org.apache.poi.hssf.record.crypto.Biff8EncryptionKey; import org.apache.poi.sl.image.ImageHeaderEMF; import org.apache.poi.sl.image.ImageHeaderPICT; import org.apache.poi.sl.image.ImageHeaderWMF; import org.apache.poi.sl.usermodel.PictureData.PictureType; import org.apache.poi.util.RandomSingleton; import org.apache.poi.util.Units; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.CsvSource; /** * Test adding/reading pictures */ public final class TestPictures { private static final POIDataSamples slTests = POIDataSamples.getSlideShowInstance(); /** * Test add/read/write images */ @ParameterizedTest() @CsvSource(value = { // in PICT the first 512 bytes are MAC specific and may not be preserved, ignore them "PICT, cow.pict, 197, 137, 512, org.apache.poi.hslf.blip.PICT", // in WMF the first 22 bytes - is a metafile header "WMF, santa.wmf, 136, 146, 22, org.apache.poi.hslf.blip.WMF", "EMF, wrench.emf, 190, 115, 0, org.apache.poi.hslf.blip.EMF", "PNG, tomcat.png, 129, 92, 0, org.apache.poi.hslf.blip.PNG", "JPEG, clock.jpg, 192, 176, 0, org.apache.poi.hslf.blip.JPEG", "DIB, clock.dib, 192, 176, 0, org.apache.poi.hslf.blip.DIB" }) void testAddPictures(PictureType pictureType, String imgFile, int expWidth, int expHeight, int headerOffset, Class imgClazz) throws IOException { byte[] src_bytes = slTests.readFile(imgFile); int dataIndex; try (HSLFSlideShow ppt1 = new HSLFSlideShow()) { HSLFSlide slide1 = ppt1.createSlide(); HSLFPictureData data1 = ppt1.addPicture(src_bytes, pictureType); dataIndex = data1.getIndex(); // TODO: Fix the differences in the frame sizes Dimension2D dimN, dimFrame1, dimFrame2; switch (pictureType) { case PICT: dimN = new ImageHeaderPICT(src_bytes, headerOffset).getSize(); dimFrame1 = Units.pointsToPixel(dimN); dimFrame2 = dimN; break; case WMF: dimN = new ImageHeaderWMF(src_bytes, 0).getSize(); dimFrame1 = Units.pointsToPixel(dimN); dimFrame2 = dimN; break; case EMF: dimN = new ImageHeaderEMF(src_bytes, 0).getSize(); dimFrame1 = Units.pointsToPixel(dimN); dimFrame2 = dimN; break; case JPEG: case DIB: case PNG: { BufferedImage png = ImageIO.read(new ByteArrayInputStream(src_bytes)); dimN = new Dimension(png.getWidth(), png.getHeight()); dimFrame1 = dimN; dimFrame2 = Units.pixelToPoints(dimN); break; } default: fail(); return; } assertEquals(expWidth, dimN.getWidth(), 1); assertEquals(expHeight, dimN.getHeight(), 1); Dimension dim1 = data1.getImageDimensionInPixels(); assertEquals(dimFrame1.getWidth(), dim1.getWidth(), 1); assertEquals(dimFrame1.getHeight(), dim1.getHeight(), 1); HSLFPictureShape pict1 = new HSLFPictureShape(data1); assertEquals(data1.getIndex(), pict1.getPictureIndex()); slide1.addShape(pict1); try (HSLFSlideShow ppt2 = writeOutAndReadBack(ppt1)) { //make sure we can read this picture shape and it refers to the correct picture data List sh2 = ppt2.getSlides().get(0).getShapes(); assertEquals(1, sh2.size()); HSLFPictureShape pict2 = (HSLFPictureShape) sh2.get(0); assertEquals(dataIndex, pict2.getPictureIndex()); //check picture data List pictures2 = ppt2.getPictureData(); assertEquals(1, pictures2.size()); HSLFPictureData pd2 = pictures2.get(0); Dimension dim2 = pd2.getImageDimension(); assertEquals(dimFrame2.getWidth(), dim2.width, 1); assertEquals(dimFrame2.getHeight(), dim2.height, 1); //the Picture shape refers to the PictureData object in the Presentation assertEquals(pict2.getPictureData(), pd2); assertEquals(1, pictures2.size()); assertEquals(pictureType, pd2.getType()); assertTrue(imgClazz.isInstance(pd2)); //compare the content of the initial file with what is stored in the PictureData byte[] ppt_bytes = pd2.getData(); assertEquals(src_bytes.length, ppt_bytes.length); byte[] b1 = Arrays.copyOfRange(src_bytes, headerOffset, src_bytes.length); byte[] b2 = Arrays.copyOfRange(ppt_bytes, headerOffset, ppt_bytes.length); assertArrayEquals(b1, b2); } } } /** * Read pictures in different formats from a reference slide show */ @Test void testReadPictures() throws IOException { byte[] src_bytes, ppt_bytes, b1, b2; HSLFPictureShape pict; HSLFPictureData pdata; try (HSLFSlideShow ppt = getSlideShow("pictures.ppt")) { List slides = ppt.getSlides(); List pictures = ppt.getPictureData(); assertEquals(5, pictures.size()); pict = (HSLFPictureShape) slides.get(0).getShapes().get(0); //the first slide contains JPEG pdata = pict.getPictureData(); assertTrue(pdata instanceof JPEG); assertEquals(PictureType.JPEG, pdata.getType()); src_bytes = pdata.getData(); ppt_bytes = slTests.readFile("clock.jpg"); assertArrayEquals(src_bytes, ppt_bytes); pict = (HSLFPictureShape) slides.get(1).getShapes().get(0); //the second slide contains PNG pdata = pict.getPictureData(); assertTrue(pdata instanceof PNG); assertEquals(PictureType.PNG, pdata.getType()); src_bytes = pdata.getData(); ppt_bytes = slTests.readFile("tomcat.png"); assertArrayEquals(src_bytes, ppt_bytes); pict = (HSLFPictureShape) slides.get(2).getShapes().get(0); //the third slide contains WMF pdata = pict.getPictureData(); assertTrue(pdata instanceof WMF); assertEquals(PictureType.WMF, pdata.getType()); src_bytes = pdata.getData(); ppt_bytes = slTests.readFile("santa.wmf"); assertEquals(src_bytes.length, ppt_bytes.length); //ignore the first 22 bytes - it is a WMF metafile header b1 = Arrays.copyOfRange(src_bytes, 22, src_bytes.length); b2 = Arrays.copyOfRange(ppt_bytes, 22, ppt_bytes.length); assertArrayEquals(b1, b2); pict = (HSLFPictureShape) slides.get(3).getShapes().get(0); //the forth slide contains PICT pdata = pict.getPictureData(); assertTrue(pdata instanceof PICT); assertEquals(PictureType.PICT, pdata.getType()); src_bytes = pdata.getData(); ppt_bytes = slTests.readFile("cow.pict"); assertEquals(src_bytes.length, ppt_bytes.length); //ignore the first 512 bytes - it is a MAC specific crap b1 = Arrays.copyOfRange(src_bytes, 512, src_bytes.length); b2 = Arrays.copyOfRange(ppt_bytes, 512, ppt_bytes.length); assertArrayEquals(b1, b2); pict = (HSLFPictureShape) slides.get(4).getShapes().get(0); //the fifth slide contains EMF pdata = pict.getPictureData(); assertTrue(pdata instanceof EMF); assertEquals(PictureType.EMF, pdata.getType()); src_bytes = pdata.getData(); ppt_bytes = slTests.readFile("wrench.emf"); assertArrayEquals(src_bytes, ppt_bytes); } } /** * Test that on a party corrupt powerpoint document, which has * crazy pictures of type 0, we do our best. */ @Test void testZeroPictureType() throws IOException { try (HSLFSlideShowImpl hslf = new HSLFSlideShowImpl(slTests.openResourceAsStream("PictureTypeZero.ppt"))) { // Should still have 2 real pictures assertEquals(2, hslf.getPictureData().size()); // Both are real pictures, both WMF assertEquals(PictureType.WMF, hslf.getPictureData().get(0).getType()); assertEquals(PictureType.WMF, hslf.getPictureData().get(1).getType()); // Now test what happens when we use the SlideShow interface HSLFSlideShow ppt = new HSLFSlideShow(hslf); List slides = ppt.getSlides(); List pictures = ppt.getPictureData(); assertEquals(12, slides.size()); assertEquals(2, pictures.size()); HSLFPictureShape pict; HSLFPictureData pdata; pict = (HSLFPictureShape) slides.get(0).getShapes().get(1); // 2nd object on 1st slide pdata = pict.getPictureData(); assertTrue(pdata instanceof WMF); assertEquals(PictureType.WMF, pdata.getType()); pict = (HSLFPictureShape) slides.get(0).getShapes().get(2); // 3rd object on 1st slide pdata = pict.getPictureData(); assertTrue(pdata instanceof WMF); assertEquals(PictureType.WMF, pdata.getType()); } } /** * YK: The test is disabled because the owner asked to delete the test file from POI svn. * See "Please remove my file from your svn" on @poi-dev from Dec 12, 2013 */ @Test @Disabled("requires an internet connection to a 3rd party site") // As of 2017-06-20, the file still exists at the specified URL and the test passes. void testZeroPictureLength() throws IOException, URISyntaxException { // take the data from www instead of test directory URL url = new URI("http://www.cs.sfu.ca/~anoop/courses/CMPT-882-Fall-2002/chris.ppt").toURL(); HSLFSlideShowImpl hslf = new HSLFSlideShowImpl(url.openStream()); /* Assume that the file could retrieved... InputStream is; HSLFSlideShowImpl hslf; try { is = url.openStream(); hslf = new HSLFSlideShowImpl(is); is.close(); } catch (final IOException e) { Assume.assumeTrue(e.getMessage(), false); throw e; } */ // Should still have 2 real pictures assertEquals(2, hslf.getPictureData().size()); // Both are real pictures, both WMF assertEquals(PictureType.WMF, hslf.getPictureData().get(0).getType()); assertEquals(PictureType.WMF, hslf.getPictureData().get(1).getType()); // Now test what happens when we use the SlideShow interface try (HSLFSlideShow ppt = new HSLFSlideShow(hslf)) { List slides = ppt.getSlides(); List pictures = ppt.getPictureData(); assertEquals(27, slides.size()); assertEquals(2, pictures.size()); HSLFPictureShape pict; HSLFPictureData pdata; pict = (HSLFPictureShape) slides.get(6).getShapes().get(13); pdata = pict.getPictureData(); assertTrue(pdata instanceof WMF); assertEquals(PictureType.WMF, pdata.getType()); pict = (HSLFPictureShape) slides.get(7).getShapes().get(13); pdata = pict.getPictureData(); assertTrue(pdata instanceof WMF); assertEquals(PictureType.WMF, pdata.getType()); //add a new picture, it should be correctly appended to the Pictures stream CountingOutputStream out = new CountingOutputStream(NullOutputStream.INSTANCE); for (HSLFPictureData p : pictures) p.write(out); int streamSize = out.getCount(); HSLFPictureData data = ppt.addPicture(new byte[100], PictureType.JPEG); int offset = data.getOffset(); assertEquals(streamSize, offset); assertEquals(3, ppt.getPictureData().size()); } } @Test void testGetPictureName() throws IOException { try (HSLFSlideShow ppt = getSlideShow("ppt_with_png.ppt")) { HSLFSlide slide = ppt.getSlides().get(0); HSLFPictureShape p = (HSLFPictureShape) slide.getShapes().get(0); //the first slide contains JPEG assertEquals("test", p.getPictureName()); } } @Test void testSetPictureName() throws IOException { try (HSLFSlideShow ppt1 = new HSLFSlideShow()) { HSLFSlide slide = ppt1.createSlide(); byte[] img = slTests.readFile("tomcat.png"); HSLFPictureData data = ppt1.addPicture(img, PictureType.PNG); HSLFPictureShape pict = new HSLFPictureShape(data); pict.setPictureName("tomcat.png"); slide.addShape(pict); //serialize and read again try (HSLFSlideShow ppt2 = writeOutAndReadBack(ppt1)) { HSLFPictureShape p = (HSLFPictureShape) ppt2.getSlides().get(0).getShapes().get(0); assertEquals("tomcat.png", p.getPictureName()); } } } @Test void testPictureIndexIsOneBased() throws IOException { try (HSLFSlideShow ppt = getSlideShow("ppt_with_png.ppt")) { HSLFPictureData picture = ppt.getPictureData().get(0); assertEquals(1, picture.getIndex()); } } /** * Verify that it is possible for a user to change the contents of a {@link HSLFPictureData} using * {@link HSLFPictureData#setData(byte[])}, and that the changes are saved to the slideshow. */ @Test void testEditPictureData() throws IOException { byte[] newImage = slTests.readFile("tomcat.png"); // Load an existing slideshow and modify the image try (HSLFSlideShow ppt1 = getSlideShow("ppt_with_png.ppt")) { HSLFPictureData picture1 = ppt1.getPictureData().get(0); picture1.setData(newImage); // Load the modified slideshow and verify the image content try (HSLFSlideShow ppt2 = writeOutAndReadBack(ppt1)) { HSLFPictureData picture2 = ppt2.getPictureData().get(0); byte[] modifiedImageData = picture2.getData(); assertArrayEquals(newImage, modifiedImageData); } } } /** * Verify that it is possible for a user to change the contents of an encrypted {@link HSLFPictureData} using * {@link HSLFPictureData#setData(byte[])}, and that the changes are saved to the slideshow. */ @Test void testEditPictureDataEncrypted() throws IOException { byte[] newImage = slTests.readFile("tomcat.png"); Biff8EncryptionKey.setCurrentUserPassword("password"); try { // Load an existing slideshow and modify the image try (HSLFSlideShow ppt1 = getSlideShow("ppt_with_png_encrypted.ppt")) { HSLFPictureData picture1 = ppt1.getPictureData().get(0); picture1.setData(newImage); // Load the modified slideshow and verify the image content try (HSLFSlideShow ppt2 = writeOutAndReadBack(ppt1)) { HSLFPictureData picture2 = ppt2.getPictureData().get(0); byte[] modifiedImageData = picture2.getData(); assertArrayEquals(newImage, modifiedImageData); } } } finally { Biff8EncryptionKey.setCurrentUserPassword(null); } } /** * Verify that the {@link EscherBSERecord#getOffset()} values are modified for all images after the image being * changed. */ @Test void testEditPictureDataRecordOffsetsAreShifted() throws IOException { int[] originalOffsets = {0, 12013, 15081, 34162, 59563}; int[] modifiedOffsets = {0, 35, 3103, 22184, 47585}; try (HSLFSlideShow ppt1 = getSlideShow("pictures.ppt")) { int[] offsets1 = ppt1.getPictureData().stream().mapToInt(HSLFPictureData::getOffset).toArray(); assertArrayEquals(originalOffsets, offsets1); HSLFPictureData imageBeingChanged = ppt1.getPictureData().get(0); // It doesn't matter that this isn't a valid image. We are just testing offsets here. imageBeingChanged.setData(new byte[10]); // Verify that the in-memory representations have all been updated offsets1 = ppt1.getPictureData().stream().mapToInt(HSLFPictureData::getOffset).toArray(); assertArrayEquals(modifiedOffsets, offsets1); try (HSLFSlideShow ppt2 = writeOutAndReadBack(ppt1)) { // Verify that the persisted representations have all been updated int[] offsets2 = ppt2.getPictureData().stream().mapToInt(HSLFPictureData::getOffset).toArray(); assertArrayEquals(modifiedOffsets, offsets2); } } } /** * Verify that the {@link EscherBSERecord#getOffset()} values are modified for all images after the image being * changed, but assuming that the records are not stored in a sorted-by-offset fashion. * * We have not encountered a file that has meaningful data that is not sorted. However, we have encountered files * that have records with an offset of 0 interspersed between meaningful records. See {@code 53446.ppt} and * {@code alterman_security.ppt} for examples. */ @Test void testEditPictureDataOutOfOrderRecords() throws IOException { int[] modifiedOffsets = {0, 35, 3103, 22184, 47585}; try (HSLFSlideShow ppt1 = getSlideShow("pictures.ppt")) { // For this test we're going to intentionally manipulate the records into a shuffled order. EscherContainerRecord container = ppt1.getPictureData().get(0).bStore; List children = container.getChildRecords(); for (EscherRecord child : children) { container.removeChildRecord(child); } Collections.shuffle(children); for (EscherRecord child : children) { container.addChildRecord(child); } HSLFPictureData imageBeingChanged = ppt1.getPictureData().get(0); // It doesn't matter that this isn't a valid image. We are just testing offsets here. imageBeingChanged.setData(new byte[10]); // Verify that the in-memory representations have all been updated int[] offsets1 = ppt1.getPictureData().stream().mapToInt(HSLFPictureData::getOffset).sorted().toArray(); assertArrayEquals(modifiedOffsets, offsets1); try (HSLFSlideShow ppt2 = writeOutAndReadBack(ppt1)) { // Verify that the persisted representations have all been updated int[] offsets2 = ppt2.getPictureData().stream().mapToInt(HSLFPictureData::getOffset).sorted().toArray(); assertArrayEquals(modifiedOffsets, offsets2); } } } /** * Verify that a slideshow with records that have offsets not matching those of the pictures in the stream still * correctly pairs the records and pictures. */ @Test void testSlideshowWithIncorrectOffsets() throws IOException { int[] originalOffsets; int originalNumberOfRecords; // Create a presentation that has records with unmatched offsets, but with matched UIDs. try (HSLFSlideShow ppt1 = getSlideShow("pictures.ppt")) { originalOffsets = ppt1.getPictureData().stream().mapToInt(HSLFPictureData::getOffset).toArray(); originalNumberOfRecords = ppt1.getPictureData().get(0).bStore.getChildCount(); for (HSLFPictureData picture : ppt1.getPictureData()) { // Bound is arbitrary and irrelevant to the test. picture.bse.setOffset(RandomSingleton.getInstance().nextInt(500_000)); } try (HSLFSlideShow ppt2 = writeOutAndReadBack(ppt1)) { // Verify that the offsets all got fixed. int[] offsets = ppt2.getPictureData().stream().mapToInt(HSLFPictureData::getOffset).toArray(); assertArrayEquals(originalOffsets, offsets); // Verify that there are the same number of records as in the original slideshow. int numberOfRecords = ppt2.getPictureData().get(0).bStore.getChildCount(); assertEquals(originalNumberOfRecords, numberOfRecords); } } } }