FOP-2363: Better error message when PDF/A enabled and SVG contains bitmap with transparency

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1584765 13f79535-47bb-0310-9956-ffa450edef68

8 files changed, 117 insertions, 8 deletions

diff --git a/src/java/org/apache/fop/pdf/PDFProfile.java b/src/java/org/apache/fop/pdf/PDFProfile.java
index 4ae5ba8df..4289d0ee8 100644
--- a/src/java/org/apache/fop/pdf/PDFProfile.java
+++ b/src/java/org/apache/fop/pdf/PDFProfile.java
@@ -171,8 +171,7 @@ public class PDFProfile {
     public void verifyTransparencyAllowed(String context) {
         Object profile = isTransparencyAllowed();
         if (profile != null) {
-            throw new PDFConformanceException(profile + " does not allow the use of transparency. ("
-                    + profile + ")");
+            throw new TransparencyDisallowedException(profile, context);
         }
     }
 
diff --git a/src/java/org/apache/fop/pdf/TransparencyDisallowedException.java b/src/java/org/apache/fop/pdf/TransparencyDisallowedException.java
new file mode 100644
index 000000000..11d8baf54
--- /dev/null
+++ b/src/java/org/apache/fop/pdf/TransparencyDisallowedException.java
@@ -0,0 +1,57 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.pdf;
+
+/**
+ * The PDF profile being used does not allow transparency.
+ */
+public class TransparencyDisallowedException extends PDFConformanceException {
+
+    private static final long serialVersionUID = -1653621832449817596L;
+
+    private final Object profile;
+
+    private final String context;
+
+    public TransparencyDisallowedException(Object profile, String context) {
+        super(profile + " does not allow the use of transparency."
+                + (context == null ? "" : " (" + context + ")"));
+        this.profile = profile;
+        this.context = context;
+    }
+
+    /**
+     * Returns the profile that is being used and disallows transparency.
+     *
+     * @see PDFAMode
+     * @see PDFXMode
+     */
+    public Object getProfile() {
+        return profile;
+    }
+
+    /**
+     * Returns context information to help spotting the problem.
+     */
+    public String getContext() {
+        return context;
+    }
+
+}
diff --git a/src/java/org/apache/fop/render/pdf/PDFImageHandlerSVG.java b/src/java/org/apache/fop/render/pdf/PDFImageHandlerSVG.java
index ae282f149..a71fe9417 100644
--- a/src/java/org/apache/fop/render/pdf/PDFImageHandlerSVG.java
+++ b/src/java/org/apache/fop/render/pdf/PDFImageHandlerSVG.java
@@ -44,6 +44,7 @@ import org.apache.fop.apps.FOUserAgent;
 import org.apache.fop.events.EventBroadcaster;
 import org.apache.fop.image.loader.batik.BatikImageFlavors;
 import org.apache.fop.image.loader.batik.BatikUtil;
+import org.apache.fop.pdf.TransparencyDisallowedException;
 import org.apache.fop.render.ImageHandler;
 import org.apache.fop.render.ImageHandlerUtil;
 import org.apache.fop.render.RenderingContext;
@@ -207,6 +208,10 @@ public class PDFImageHandlerSVG implements ImageHandler {
             root.paint(graphics);
             ctx.dispose();
             generator.add(graphics.getString());
+        } catch (TransparencyDisallowedException e) {
+            SVGEventProducer eventProducer = SVGEventProducer.Provider.get(
+                    context.getUserAgent().getEventBroadcaster());
+            eventProducer.bitmapWithTransparency(this, e.getProfile(), image.getInfo().getOriginalURI());
         } catch (Exception e) {
             SVGEventProducer eventProducer = SVGEventProducer.Provider.get(
                     context.getUserAgent().getEventBroadcaster());
diff --git a/src/java/org/apache/fop/svg/SVGEventProducer.java b/src/java/org/apache/fop/svg/SVGEventProducer.java
index 6bf7ed100..fd529ef04 100644
--- a/src/java/org/apache/fop/svg/SVGEventProducer.java
+++ b/src/java/org/apache/fop/svg/SVGEventProducer.java
@@ -98,4 +98,13 @@ public interface SVGEventProducer extends EventProducer {
      */
     void transparencyIgnored(Object source, Object pdfProfile, String uri);
 
+
+    /**
+     * SVG references a bitmap image that contains transparency while it is not allowed.
+     * @param source the event source
+     * @param pdfProfile the PDF profile that disallows transparency
+     * @param uri the image URI, if available
+     * @event.severity ERROR
+     */
+    void bitmapWithTransparency(Object source, Object pdfProfile, String uri);
 }
diff --git a/src/java/org/apache/fop/svg/SVGEventProducer.xml b/src/java/org/apache/fop/svg/SVGEventProducer.xml
index f5e1d300a..e7d9b555d 100644
--- a/src/java/org/apache/fop/svg/SVGEventProducer.xml
+++ b/src/java/org/apache/fop/svg/SVGEventProducer.xml
@@ -23,4 +23,5 @@
   <message key="svgNotBuilt">SVG graphic could not be built. Reason: {e}</message>
   <message key="svgRenderingError">SVG graphic could not be rendered. Reason: {e}</message>
   <message key="transparencyIgnored">Transparency in an SVG image will be ignored because {pdfProfile} does not allow it[ (see {uri})].</message>
+  <message key="bitmapWithTransparency">An SVG image is referencing a bitmap with transparency while {pdfProfile} does not allow it[ (see {uri})].</message>
 </catalogue>
diff --git a/test/java/org/apache/fop/events/EventChecker.java b/test/java/org/apache/fop/events/EventChecker.java
index 506658467..c2d5fcfd6 100644
--- a/test/java/org/apache/fop/events/EventChecker.java
+++ b/test/java/org/apache/fop/events/EventChecker.java
@@ -46,7 +46,7 @@ public class EventChecker implements EventListener {
         if (id.equals(expectedEventID)) {
             eventReceived = true;
             for (Map.Entry<String, Object> param : expectedParams.entrySet()) {
-                assertEquals(event.getParam(param.getKey()), param.getValue());
+                assertEquals(param.getValue(), event.getParam(param.getKey()));
             }
         }
     }
diff --git a/test/java/org/apache/fop/render/pdf/PDFAConformanceTestCase.java b/test/java/org/apache/fop/render/pdf/PDFAConformanceTestCase.java
index b2b77e842..752d666c5 100644
--- a/test/java/org/apache/fop/render/pdf/PDFAConformanceTestCase.java
+++ b/test/java/org/apache/fop/render/pdf/PDFAConformanceTestCase.java
@@ -115,15 +115,29 @@ public class PDFAConformanceTestCase extends BasePDFTest {
 
     @Test
     public void svgTransparency() throws Exception {
-        Map<String, Object> params = new HashMap<String, Object>();
-        params.put("pdfProfile", PDFAMode.PDFA_1B);
-        EventChecker eventChecker = new EventChecker(SVGEventProducer.class.getName()
-                + ".transparencyIgnored", params);
         FOUserAgent ua = getUserAgent();
-        ua.getEventBroadcaster().addEventListener(eventChecker);
+        EventChecker eventChecker = setupEventChecker(ua, "transparencyIgnored");
         File foFile = new File(foBaseDir, "svg-transparency.fo");
         convertFO(foFile, ua, dumpPDF);
         eventChecker.end();
     }
 
+    @Test
+    public void svgContainingBitmapWithTransparency() throws Exception {
+        FOUserAgent ua = getUserAgent();
+        EventChecker eventChecker = setupEventChecker(ua, "bitmapWithTransparency");
+        File foFile = new File(foBaseDir, "svg-with-transparent-image.fo");
+        convertFO(foFile, ua, dumpPDF);
+        eventChecker.end();
+    }
+
+    private EventChecker setupEventChecker(FOUserAgent ua, String expectedEvent) {
+        Map<String, Object> params = new HashMap<String, Object>();
+        params.put("pdfProfile", PDFAMode.PDFA_1B);
+        EventChecker eventChecker = new EventChecker(SVGEventProducer.class.getName()
+                + "." + expectedEvent, params);
+        ua.getEventBroadcaster().addEventListener(eventChecker);
+        return eventChecker;
+    }
+
 }
diff --git a/test/xml/pdf-a/svg-with-transparent-image.fo b/test/xml/pdf-a/svg-with-transparent-image.fo
new file mode 100644
index 000000000..503872224
--- /dev/null
+++ b/test/xml/pdf-a/svg-with-transparent-image.fo
@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" font-family="Gladiator">
+  <fo:layout-master-set>
+    <fo:simple-page-master master-name="page"
+      page-height="320pt" page-width="420pt" margin="10pt">
+      <fo:region-body display-align="center"/>
+    </fo:simple-page-master>
+  </fo:layout-master-set>
+  <fo:page-sequence master-reference="page">
+    <fo:flow flow-name="xsl-region-body" text-align="center">
+      <fo:block start-indent="50pt" end-indent="50pt" font-size="15pt" space-after="10pt">SVG 
+        referencing a bitmap image that has transparency</fo:block>
+      <fo:block><fo:instream-foreign-object>
+          <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" 
+            width="100" height="100">
+            <rect x="0" y="0" width="100%" height="100%" fill="none" stroke="black" 
+              stroke-width="2"/>
+            <image x="0" y="0" width="100%" height="100%" 
+              xlink:href="resources/images/list-item.png"/>
+          </svg>
+      </fo:instream-foreign-object></fo:block>
+    </fo:flow>
+  </fo:page-sequence>
+</fo:root>