FOP-3228: Limit embed of only native PDF in AFP

simonsteiner1984 · simonsteiner1984 · commit 7f201b321490 · 2025-01-10T10:05:55.000Z
diff --git a/fop-core/src/main/java/org/apache/fop/afp/AFPPaintingState.java b/fop-core/src/main/java/org/apache/fop/afp/AFPPaintingState.java
@@ -67,6 +67,7 @@ public class AFPPaintingState extends org.apache.fop.util.AbstractPaintingState
      * format.
      */
     private boolean nativeImagesSupported;
+    private boolean nativePDFImagesSupported;
 
     private boolean canEmbedJpeg;
 
@@ -254,6 +255,14 @@ public boolean isNativeImagesSupported() {
         return this.nativeImagesSupported;
     }
 
+    public void setNativePDFImagesSupported(boolean nativePDFImagesSupported) {
+        this.nativePDFImagesSupported = nativePDFImagesSupported;
+    }
+
+    public boolean isNativePDFImagesSupported() {
+        return nativePDFImagesSupported;
+    }
+
     /**
      * Set whether or not JPEG images can be embedded within an AFP document.
      *
diff --git a/fop-core/src/main/java/org/apache/fop/render/ImageHandlerRegistry.java b/fop-core/src/main/java/org/apache/fop/render/ImageHandlerRegistry.java
@@ -142,11 +142,11 @@ public ImageHandler getHandler(RenderingContext targetContext, Image image) {
      * @param context the rendering context
      * @return the array of image flavors
      */
-    public synchronized ImageFlavor[] getSupportedFlavors(RenderingContext context) {
+    public synchronized ImageFlavor[] getSupportedFlavors(RenderingContext context, Image image) {
         //Extract all ImageFlavors into a single array
         List<ImageFlavor> flavors = new java.util.ArrayList<ImageFlavor>();
         for (ImageHandler handler : this.handlerList) {
-            if (handler.isCompatible(context, null)) {
+            if (handler.isCompatible(context, image)) {
                 ImageFlavor[] f = handler.getSupportedImageFlavors();
                 Collections.addAll(flavors, f);
             }
diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/AFPDocumentHandler.java b/fop-core/src/main/java/org/apache/fop/render/afp/AFPDocumentHandler.java
@@ -476,6 +476,10 @@ public void setNativeImagesSupported(boolean nativeImages) {
         paintingState.setNativeImagesSupported(nativeImages);
     }
 
+    public void setNativePDFImagesSupported(boolean nativeImages) {
+        paintingState.setNativePDFImagesSupported(nativeImages);
+    }
+
     /** {@inheritDoc} */
     public void setCMYKImagesSupported(boolean value) {
         paintingState.setCMYKImagesSupported(value);
diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/AFPImageHandlerRawStream.java b/fop-core/src/main/java/org/apache/fop/render/afp/AFPImageHandlerRawStream.java
@@ -86,6 +86,9 @@ public void handleImage(RenderingContext context, Image image, Rectangle pos)
     public boolean isCompatible(RenderingContext targetContext, Image image) {
         if (targetContext instanceof AFPRenderingContext) {
             AFPRenderingContext afpContext = (AFPRenderingContext)targetContext;
+            if (afpContext.getPaintingState().isNativePDFImagesSupported() && isPDFCompatible(image)) {
+                return true;
+            }
             return (afpContext.getPaintingState().isNativeImagesSupported())
                 && (image == null
                         || image instanceof ImageRawJPEG
@@ -99,4 +102,12 @@ private boolean isCompatible(ImageRawStream rawStream) {
         return MimeConstants.MIME_TIFF.equals(rawStream.getMimeType())
                 || MimeConstants.MIME_PDF.equals(rawStream.getMimeType());
     }
+
+    private boolean isPDFCompatible(Image image) {
+        if (image instanceof ImageRawStream) {
+            ImageRawStream rawStream = (ImageRawStream)image;
+            return MimeConstants.MIME_PDF.equals(rawStream.getMimeType());
+        }
+        return false;
+    }
 }
diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/AFPPainter.java b/fop-core/src/main/java/org/apache/fop/render/afp/AFPPainter.java
@@ -47,6 +47,7 @@
 import org.apache.xmlgraphics.image.loader.ImageSessionContext;
 import org.apache.xmlgraphics.image.loader.ImageSize;
 import org.apache.xmlgraphics.image.loader.impl.ImageGraphics2D;
+import org.apache.xmlgraphics.image.loader.impl.ImageRawStream;
 import org.apache.xmlgraphics.java2d.Graphics2DImagePainter;
 
 import org.apache.fop.afp.AFPBorderPainter;
@@ -68,6 +69,7 @@
 import org.apache.fop.afp.ptoca.PtocaBuilder;
 import org.apache.fop.afp.ptoca.PtocaProducer;
 import org.apache.fop.afp.util.AFPResourceAccessor;
+import org.apache.fop.apps.MimeConstants;
 import org.apache.fop.fonts.Font;
 import org.apache.fop.fonts.FontTriplet;
 import org.apache.fop.fonts.Typeface;
@@ -1151,4 +1153,15 @@ public void fillBackground(Rectangle rect, Paint fill, BorderProps bpsBefore,
             BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) throws IFException {
         // not supported in AFP
     }
+
+    protected Image getImageForSupportedFlavors(ImageInfo info) {
+        if (getPaintingState().isNativePDFImagesSupported() && MimeConstants.MIME_PDF.equals(info.getMimeType())) {
+            return new ImageRawStream(info, null, (ImageRawStream.InputStreamFactory) null) {
+                public String getMimeType() {
+                    return MimeConstants.MIME_PDF;
+                }
+            };
+        }
+        return null;
+    }
 }
diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/AFPRendererConfig.java b/fop-core/src/main/java/org/apache/fop/render/afp/AFPRendererConfig.java
@@ -57,6 +57,7 @@
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_MASK_ENABLED;
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_MODE;
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_NATIVE;
+import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_NATIVE_PDF;
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_WRAP_PSEG;
 import static org.apache.fop.render.afp.AFPRendererOption.JPEG_ALLOW_JPEG_EMBEDDING;
 import static org.apache.fop.render.afp.AFPRendererOption.JPEG_BITMAP_ENCODING_QUALITY;
@@ -148,6 +149,10 @@ public Boolean isNativeImagesSupported() {
         return getParam(IMAGES_NATIVE, Boolean.class);
     }
 
+    public Boolean isNativePDFImagesSupported() {
+        return getParam(IMAGES_NATIVE_PDF, Boolean.class);
+    }
+
     public AFPShadingMode getShadingMode() {
         return getParam(SHADING, AFPShadingMode.class);
     }
@@ -322,8 +327,8 @@ private void configureImages() throws ConfigurationException, FOPException {
             }
             setParam(IMAGES_DITHERING_QUALITY, dq);
             setParam(IMAGES_NATIVE, imagesCfg.getAttributeAsBoolean(IMAGES_NATIVE.getName(), false));
-            setParam(IMAGES_WRAP_PSEG,
-                    imagesCfg.getAttributeAsBoolean(IMAGES_WRAP_PSEG.getName(), false));
+            setParam(IMAGES_NATIVE_PDF, imagesCfg.getAttributeAsBoolean(IMAGES_NATIVE_PDF.getName(), false));
+            setParam(IMAGES_WRAP_PSEG, imagesCfg.getAttributeAsBoolean(IMAGES_WRAP_PSEG.getName(), false));
             setParam(IMAGES_FS45, imagesCfg.getAttributeAsBoolean(IMAGES_FS45.getName(), false));
             setParam(IMAGES_MASK_ENABLED, imagesCfg.getAttributeAsBoolean(IMAGES_MASK_ENABLED.getName(), false));
             if ("scale-to-fit".equals(imagesCfg.getAttribute(IMAGES_MAPPING_OPTION.getName(), null))) {
diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/AFPRendererConfigurator.java b/fop-core/src/main/java/org/apache/fop/render/afp/AFPRendererConfigurator.java
@@ -84,6 +84,9 @@ private void configure(AFPDocumentHandler documentHandler, AFPRendererConfig con
         if (config.isNativeImagesSupported() != null) {
             documentHandler.setNativeImagesSupported(config.isNativeImagesSupported());
         }
+        if (config.isNativePDFImagesSupported() != null) {
+            documentHandler.setNativePDFImagesSupported(config.isNativePDFImagesSupported());
+        }
         if (config.getShadingMode() != null) {
             documentHandler.setShadingMode(config.getShadingMode());
         }
diff --git a/fop-core/src/main/java/org/apache/fop/render/afp/AFPRendererOption.java b/fop-core/src/main/java/org/apache/fop/render/afp/AFPRendererOption.java
@@ -35,6 +35,7 @@ public enum AFPRendererOption implements RendererConfigOption {
     IMAGES_MAPPING_OPTION("mapping_option", Byte.class),
     IMAGES_MODE("mode", Boolean.class),
     IMAGES_NATIVE("native", Boolean.class),
+    IMAGES_NATIVE_PDF("native-pdf", Boolean.class),
     IMAGES_WRAP_PSEG("pseg", Boolean.class),
     JPEG_ALLOW_JPEG_EMBEDDING("allow-embedding", Boolean.class),
     JPEG_BITMAP_ENCODING_QUALITY("bitmap-encoding-quality", Float.class),
diff --git a/fop-core/src/main/java/org/apache/fop/render/intermediate/AbstractIFPainter.java b/fop-core/src/main/java/org/apache/fop/render/intermediate/AbstractIFPainter.java
@@ -158,7 +158,7 @@ protected void drawImageUsingImageHandler(ImageInfo info, Rectangle rect)
         Map hints = createDefaultImageProcessingHints(sessionContext);
         context.putHints(hints);
 
-        ImageFlavor[] flavors = imageHandlerRegistry.getSupportedFlavors(context);
+        ImageFlavor[] flavors = imageHandlerRegistry.getSupportedFlavors(context, getImageForSupportedFlavors(info));
         info.getCustomObjects().put("warningincustomobject", true);
         org.apache.xmlgraphics.image.loader.Image img = manager.getImage(
                     info, flavors,
@@ -181,6 +181,10 @@ protected void drawImageUsingImageHandler(ImageInfo info, Rectangle rect)
         }
     }
 
+    protected Image getImageForSupportedFlavors(ImageInfo info) {
+        return null;
+    }
+
     /**
      * Creates the default map of processing hints for the image loading framework.
      * @param sessionContext the session context for access to resolution information
@@ -234,8 +238,7 @@ protected void drawImage(Image image, Rectangle rect,
             if (additionalHints != null) {
                 hints.putAll(additionalHints);
             }
-            effImage = manager.convertImage(image,
-                    imageHandlerRegistry.getSupportedFlavors(context), hints);
+            effImage = manager.convertImage(image, imageHandlerRegistry.getSupportedFlavors(context, null), hints);
         } else {
             effImage = image;
         }
diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/PSImageUtils.java b/fop-core/src/main/java/org/apache/fop/render/ps/PSImageUtils.java
@@ -81,7 +81,7 @@ private static ImageFlavor[] determineSupportedImageFlavors(RenderingContext ren
         ImageFlavor[] inlineFlavors;
         ImageHandlerRegistry imageHandlerRegistry
             = renderingContext.getUserAgent().getImageHandlerRegistry();
-        inlineFlavors = imageHandlerRegistry.getSupportedFlavors(renderingContext);
+        inlineFlavors = imageHandlerRegistry.getSupportedFlavors(renderingContext, null);
         return inlineFlavors;
     }
 
diff --git a/fop-core/src/main/java/org/apache/fop/render/ps/ResourceHandler.java b/fop-core/src/main/java/org/apache/fop/render/ps/ResourceHandler.java
@@ -297,7 +297,7 @@ private void generateFormForImage(PSGenerator gen, PSImageFormResource form)
             ImageFlavor[] flavors;
             ImageHandlerRegistry imageHandlerRegistry
                 = userAgent.getImageHandlerRegistry();
-            flavors = imageHandlerRegistry.getSupportedFlavors(formContext);
+            flavors = imageHandlerRegistry.getSupportedFlavors(formContext, null);
 
             Map hints = ImageUtil.getDefaultHints(sessionContext);
             org.apache.xmlgraphics.image.loader.Image img = manager.getImage(
diff --git a/fop-core/src/test/java/org/apache/fop/apps/AFPRendererConfBuilder.java b/fop-core/src/test/java/org/apache/fop/apps/AFPRendererConfBuilder.java
@@ -40,6 +40,7 @@
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_MASK_ENABLED;
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_MODE;
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_NATIVE;
+import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_NATIVE_PDF;
 import static org.apache.fop.render.afp.AFPRendererOption.IMAGES_WRAP_PSEG;
 import static org.apache.fop.render.afp.AFPRendererOption.JPEG_ALLOW_JPEG_EMBEDDING;
 import static org.apache.fop.render.afp.AFPRendererOption.JPEG_BITMAP_ENCODING_QUALITY;
@@ -174,6 +175,10 @@ public ImagesBuilder setNativeImageSupport(boolean value) {
             return setAttribute(IMAGES_NATIVE, value);
         }
 
+        public ImagesBuilder setNativePDFImageSupport(boolean value) {
+            return setAttribute(IMAGES_NATIVE_PDF, value);
+        }
+
         public AFPRendererConfBuilder endImages() {
             return AFPRendererConfBuilder.this.endImages();
         }
diff --git a/fop-core/src/test/java/org/apache/fop/render/afp/AFPImageHandlerRawStreamTestCase.java b/fop-core/src/test/java/org/apache/fop/render/afp/AFPImageHandlerRawStreamTestCase.java
@@ -40,4 +40,15 @@ public void testIsCompatible() {
         Assert.assertFalse(Arrays.asList(
                 new AFPImageHandlerRawStream().getSupportedImageFlavors()).contains(ImageFlavor.RAW));
     }
+
+    @Test
+    public void testPDFIsCompatible() {
+        AFPPaintingState state = new AFPPaintingState();
+        state.setNativePDFImagesSupported(true);
+        AFPRenderingContext context = new AFPRenderingContext(null, null, state, null, null);
+        ImageRawStream stream = new ImageRawStream(null, ImageFlavor.RAW_PDF, (InputStream) null);
+        Assert.assertTrue(new AFPImageHandlerRawStream().isCompatible(context, stream));
+        stream = new ImageRawStream(null, ImageFlavor.RAW_JPEG, (InputStream) null);
+        Assert.assertFalse(new AFPImageHandlerRawStream().isCompatible(context, stream));
+    }
 }
diff --git a/fop-core/src/test/java/org/apache/fop/render/afp/AFPRendererConfigParserTestCase.java b/fop-core/src/test/java/org/apache/fop/render/afp/AFPRendererConfigParserTestCase.java
@@ -123,6 +123,17 @@ public void testImages() throws Exception {
         assertEquals(true, conf.isCmykImagesSupported());
     }
 
+    @Test
+    public void testNativePDFImages() throws Exception {
+        parseConfig();
+        assertFalse(conf.isNativePDFImagesSupported());
+        parseConfig(createRenderer()
+                .startImages()
+                .setNativePDFImageSupport(true)
+                .endImages());
+        assertTrue(conf.isNativePDFImagesSupported());
+    }
+
     @Test(expected = IllegalStateException.class)
     public void testImagesException1() throws Exception {
         parseConfig(createRenderer().startImages().endImages());

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,9 @@ private void configure(AFPDocumentHandler documentHandler, AFPRendererConfig con`
`84`	`84`	`if (config.isNativeImagesSupported() != null) {`
`85`	`85`	`documentHandler.setNativeImagesSupported(config.isNativeImagesSupported());`
`86`	`86`	`}`
	`87`	`+ if (config.isNativePDFImagesSupported() != null) {`
	`88`	`+ documentHandler.setNativePDFImagesSupported(config.isNativePDFImagesSupported());`
	`89`	`+ }`
`87`	`90`	`if (config.getShadingMode() != null) {`
`88`	`91`	`documentHandler.setShadingMode(config.getShadingMode());`
`89`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ private static ImageFlavor[] determineSupportedImageFlavors(RenderingContext ren`
`81`	`81`	`ImageFlavor[] inlineFlavors;`
`82`	`82`	`ImageHandlerRegistry imageHandlerRegistry`
`83`	`83`	`= renderingContext.getUserAgent().getImageHandlerRegistry();`
`84`		`- inlineFlavors = imageHandlerRegistry.getSupportedFlavors(renderingContext);`
	`84`	`+ inlineFlavors = imageHandlerRegistry.getSupportedFlavors(renderingContext, null);`
`85`	`85`	`return inlineFlavors;`
`86`	`86`	`}`
`87`	`87`