123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288 |
- /*
- * 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.render.pdf;
-
- import java.awt.Color;
- import java.awt.Rectangle;
- import java.awt.geom.AffineTransform;
- import java.io.IOException;
-
- import org.w3c.dom.Document;
-
- import org.apache.commons.logging.Log;
- import org.apache.commons.logging.LogFactory;
-
- import org.apache.batik.anim.dom.SVGDOMImplementation;
- import org.apache.batik.bridge.BridgeContext;
- import org.apache.batik.bridge.GVTBuilder;
- import org.apache.batik.gvt.GraphicsNode;
- import org.apache.batik.util.SVGConstants;
-
- import org.apache.xmlgraphics.image.loader.Image;
- import org.apache.xmlgraphics.image.loader.ImageFlavor;
- import org.apache.xmlgraphics.image.loader.impl.ImageXMLDOM;
- import org.apache.xmlgraphics.util.UnitConv;
-
- 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;
- import org.apache.fop.render.pdf.PDFLogicalStructureHandler.MarkedContentInfo;
- import org.apache.fop.render.ps.PSImageHandlerSVG;
- import org.apache.fop.svg.PDFAElementBridge;
- import org.apache.fop.svg.PDFBridgeContext;
- import org.apache.fop.svg.PDFGraphics2D;
- import org.apache.fop.svg.SVGEventProducer;
- import org.apache.fop.svg.SVGUserAgent;
- import org.apache.fop.svg.font.FOPFontFamilyResolverImpl;
-
- /**
- * Image Handler implementation which handles SVG images.
- */
- public class PDFImageHandlerSVG implements ImageHandler {
-
- /** logging instance */
- private static Log log = LogFactory.getLog(PDFImageHandlerSVG.class);
-
- /** {@inheritDoc} */
- public void handleImage(RenderingContext context,
- Image image, Rectangle pos)
- throws IOException {
- PDFRenderingContext pdfContext = (PDFRenderingContext)context;
- PDFContentGenerator generator = pdfContext.getGenerator();
- ImageXMLDOM imageSVG = (ImageXMLDOM)image;
-
- FOUserAgent userAgent = context.getUserAgent();
- final float deviceResolution = userAgent.getTargetResolution();
- if (log.isDebugEnabled()) {
- log.debug("Generating SVG at " + deviceResolution + "dpi.");
- }
-
- final float uaResolution = userAgent.getSourceResolution();
- SVGUserAgent ua = new SVGUserAgent(userAgent, new FOPFontFamilyResolverImpl(pdfContext.getFontInfo()),
- new AffineTransform());
-
- GVTBuilder builder = new GVTBuilder();
-
- //Controls whether text painted by Batik is generated using text or path operations
- boolean strokeText = PSImageHandlerSVG.shouldStrokeText(imageSVG.getDocument().getChildNodes());
- //TODO connect with configuration elsewhere.
-
- BridgeContext ctx = new PDFBridgeContext(ua,
- (strokeText ? null : pdfContext.getFontInfo()),
- userAgent.getImageManager(),
- userAgent.getImageSessionContext(),
- new AffineTransform());
-
- //Cloning SVG DOM as Batik attaches non-thread-safe facilities (like the CSS engine)
- //to it.
- Document clonedDoc = BatikUtil.cloneSVGDocument(imageSVG.getDocument());
-
- GraphicsNode root;
- try {
- root = builder.build(ctx, clonedDoc);
- } catch (Exception e) {
- SVGEventProducer eventProducer = SVGEventProducer.Provider.get(
- context.getUserAgent().getEventBroadcaster());
- eventProducer.svgNotBuilt(this, e, image.getInfo().getOriginalURI());
- return;
- }
- // get the 'width' and 'height' attributes of the SVG document
- float w = image.getSize().getWidthMpt();
- float h = image.getSize().getHeightMpt();
-
- float sx = pos.width / w;
- float sy = pos.height / h;
-
- //Scaling and translation for the bounding box of the image
- AffineTransform scaling = new AffineTransform(
- sx, 0, 0, sy, pos.x / 1000f, pos.y / 1000f);
- double sourceScale = UnitConv.IN2PT / uaResolution;
- scaling.scale(sourceScale, sourceScale);
-
- //Scale for higher resolution on-the-fly images from Batik
- AffineTransform resolutionScaling = new AffineTransform();
- double targetScale = uaResolution / deviceResolution;
- resolutionScaling.scale(targetScale, targetScale);
- resolutionScaling.scale(1.0 / sx, 1.0 / sy);
-
- //Transformation matrix that establishes the local coordinate system for the SVG graphic
- //in relation to the current coordinate system
- AffineTransform imageTransform = new AffineTransform();
- imageTransform.concatenate(scaling);
- imageTransform.concatenate(resolutionScaling);
-
- if (log.isTraceEnabled()) {
- log.trace("nat size: " + w + "/" + h);
- log.trace("req size: " + pos.width + "/" + pos.height);
- log.trace("source res: " + uaResolution + ", targetRes: " + deviceResolution
- + " --> target scaling: " + targetScale);
- log.trace(image.getSize());
- log.trace("sx: " + sx + ", sy: " + sy);
- log.trace("scaling: " + scaling);
- log.trace("resolution scaling: " + resolutionScaling);
- log.trace("image transform: " + resolutionScaling);
- }
-
- /*
- * Clip to the svg area.
- * Note: To have the svg overlay (under) a text area then use
- * an fo:block-container
- */
- if (log.isTraceEnabled()) {
- generator.comment("SVG setup");
- }
- generator.saveGraphicsState();
- if (context.getUserAgent().isAccessibilityEnabled()) {
- MarkedContentInfo mci = pdfContext.getMarkedContentInfo();
- generator.beginMarkedContentSequence(mci.tag, mci.mcid);
- }
- generator.updateColor(Color.black, false, null);
- generator.updateColor(Color.black, true, null);
-
- if (!scaling.isIdentity()) {
- if (log.isTraceEnabled()) {
- generator.comment("viewbox");
- }
- generator.add(CTMHelper.toPDFString(scaling, false) + " cm\n");
- }
-
- //SVGSVGElement svg = ((SVGDocument)doc).getRootElement();
-
- PDFGraphics2D graphics = new PDFGraphics2D(true, pdfContext.getFontInfo(),
- generator.getDocument(),
- generator.getResourceContext(), pdfContext.getPage().makeReference(),
- "", 0, new TransparencyIgnoredEventListener(pdfContext, imageSVG));
- graphics.setGraphicContext(new org.apache.xmlgraphics.java2d.GraphicContext());
-
- if (!resolutionScaling.isIdentity()) {
- if (log.isTraceEnabled()) {
- generator.comment("resolution scaling for " + uaResolution
- + " -> " + deviceResolution);
- }
- generator.add(
- CTMHelper.toPDFString(resolutionScaling, false) + " cm\n");
- graphics.scale(
- 1.0 / resolutionScaling.getScaleX(),
- 1.0 / resolutionScaling.getScaleY());
- }
-
- if (log.isTraceEnabled()) {
- generator.comment("SVG start");
- }
-
- //Save state and update coordinate system for the SVG image
- generator.getState().save();
- generator.getState().concatenate(imageTransform);
-
- //Now that we have the complete transformation matrix for the image, we can update the
- //transformation matrix for the AElementBridge.
- PDFAElementBridge aBridge = (PDFAElementBridge)ctx.getBridge(
- SVGDOMImplementation.SVG_NAMESPACE_URI, SVGConstants.SVG_A_TAG);
- aBridge.getCurrentTransform().setTransform(generator.getState().getTransform());
-
- graphics.setPaintingState(generator.getState());
- graphics.setOutputStream(generator.getOutputStream());
- try {
- 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());
- eventProducer.svgRenderingError(this, e, image.getInfo().getOriginalURI());
- }
- generator.getState().restore();
- if (context.getUserAgent().isAccessibilityEnabled()) {
- generator.restoreGraphicsStateAccess();
- } else {
- generator.restoreGraphicsState();
- }
- if (log.isTraceEnabled()) {
- generator.comment("SVG end");
- }
- }
-
- private static class TransparencyIgnoredEventListener
- implements PDFGraphics2D.TransparencyIgnoredEventListener {
-
- private final RenderingContext context;
-
- private final Image image;
-
- public TransparencyIgnoredEventListener(RenderingContext context, Image image) {
- this.context = context;
- this.image = image;
- }
-
- private boolean warningIssued;
-
- public void transparencyIgnored(Object pdfProfile) {
- if (!warningIssued) {
- EventBroadcaster broadcaster = context.getUserAgent().getEventBroadcaster();
- SVGEventProducer producer = SVGEventProducer.Provider.get(broadcaster);
- producer.transparencyIgnored(this, pdfProfile, image.getInfo().getOriginalURI());
- warningIssued = true;
- }
- }
- }
-
- /** {@inheritDoc} */
- public int getPriority() {
- return 400;
- }
-
- /** {@inheritDoc} */
- public Class getSupportedImageClass() {
- return ImageXMLDOM.class;
- }
-
- /** {@inheritDoc} */
- public ImageFlavor[] getSupportedImageFlavors() {
- return new ImageFlavor[] {
- BatikImageFlavors.SVG_DOM
- };
- }
-
- /** {@inheritDoc} */
- public boolean isCompatible(RenderingContext targetContext, Image image) {
- boolean supported = (image == null
- || (image instanceof ImageXMLDOM
- && image.getFlavor().isCompatible(BatikImageFlavors.SVG_DOM)))
- && targetContext instanceof PDFRenderingContext;
- if (supported) {
- String mode = (String)targetContext.getHint(ImageHandlerUtil.CONVERSION_MODE);
- if (ImageHandlerUtil.isConversionModeBitmap(mode)) {
- //Disabling this image handler automatically causes a bitmap to be generated
- return false;
- }
- }
- return supported;
- }
-
- }
|