123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397 |
- /*
- * 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.svg;
-
- import java.io.IOException;
- import java.io.InputStream;
-
- import javax.xml.transform.Source;
- import javax.xml.transform.stream.StreamSource;
-
- import org.w3c.dom.DOMImplementation;
- import org.xml.sax.EntityResolver;
-
- import org.apache.commons.logging.Log;
- import org.apache.commons.logging.impl.SimpleLog;
-
- import org.apache.batik.anim.dom.SVGDOMImplementation;
- import org.apache.batik.bridge.FontFamilyResolver;
- import org.apache.batik.dom.util.DocumentFactory;
- import org.apache.batik.transcoder.ErrorHandler;
- import org.apache.batik.transcoder.SVGAbstractTranscoder;
- import org.apache.batik.transcoder.TranscoderException;
- import org.apache.batik.transcoder.TranscodingHints;
- import org.apache.batik.transcoder.image.ImageTranscoder;
- import org.apache.batik.transcoder.keys.BooleanKey;
- import org.apache.batik.transcoder.keys.FloatKey;
- import org.apache.batik.util.ParsedURL;
- import org.apache.batik.util.SVGConstants;
-
- import org.apache.xmlgraphics.image.GraphicsConstants;
- import org.apache.xmlgraphics.image.loader.ImageContext;
- import org.apache.xmlgraphics.image.loader.ImageManager;
- import org.apache.xmlgraphics.image.loader.ImageSessionContext;
- import org.apache.xmlgraphics.image.loader.impl.AbstractImageSessionContext;
- import org.apache.xmlgraphics.util.UnitConv;
-
- import org.apache.fop.configuration.Configurable;
- import org.apache.fop.configuration.Configuration;
- import org.apache.fop.configuration.ConfigurationException;
- import org.apache.fop.configuration.DefaultConfiguration;
- import org.apache.fop.svg.font.FOPFontFamilyResolver;
-
- /**
- * This is the common base class of all of FOP's transcoders.
- */
- public abstract class AbstractFOPTranscoder extends SVGAbstractTranscoder implements Configurable {
-
- /**
- * The key is used to specify the resolution for on-the-fly images generated
- * due to complex effects like gradients and filters.
- */
- public static final TranscodingHints.Key KEY_DEVICE_RESOLUTION = new FloatKey();
-
- /**
- * The key to specify whether to stroke text instead of using text
- * operations.
- */
- public static final TranscodingHints.Key KEY_STROKE_TEXT = new BooleanKey();
-
- /**
- * The key is used to specify whether the available fonts should be automatically
- * detected. The alternative is to configure the transcoder manually using a configuration
- * file.
- */
- public static final TranscodingHints.Key KEY_AUTO_FONTS = new BooleanKey();
-
- /** The value to turn on text stroking. */
- public static final Boolean VALUE_FORMAT_ON = Boolean.TRUE;
-
- /** The value to turn off text stroking. */
- public static final Boolean VALUE_FORMAT_OFF = Boolean.FALSE;
-
- private Log logger;
- private EntityResolver resolver;
- private Configuration cfg;
- private ImageManager imageManager;
- private ImageSessionContext imageSessionContext;
-
- /**
- * Constructs a new FOP-style transcoder.
- */
- public AbstractFOPTranscoder() {
- hints.put(KEY_DOCUMENT_ELEMENT_NAMESPACE_URI,
- SVGConstants.SVG_NAMESPACE_URI);
- hints.put(KEY_DOCUMENT_ELEMENT, SVGConstants.SVG_SVG_TAG);
- hints.put(KEY_DOM_IMPLEMENTATION,
- SVGDOMImplementation.getDOMImplementation());
- }
-
- /**
- * Creates and returns the default user agent for this transcoder. Override
- * this method if you need non-default behaviour.
- * @return UserAgent the newly created user agent
- */
- protected FOPTranscoderUserAgent createUserAgent() {
- return new FOPTranscoderUserAgent();
- }
-
- /**
- * Sets the logger.
- * @param logger the logger
- */
- public void setLogger(Log logger) {
- this.logger = logger;
- }
-
- /**
- * Sets the EntityResolver that should be used when building SVG documents.
- * @param resolver the resolver
- */
- public void setEntityResolver(EntityResolver resolver) {
- this.resolver = resolver;
- }
-
- /**
- * @param cfg the configuration
- * @throws ConfigurationException if not caught
- */
- public void configure(Configuration cfg) throws ConfigurationException {
- this.cfg = cfg;
- }
-
- /**
- * Returns the default value for the KEY_AUTO_FONTS value.
- * @return the default value
- */
- protected boolean getAutoFontsDefault() {
- return true;
- }
-
- /**
- * Returns the effective configuration for the transcoder.
- * @return the effective configuration
- */
- protected Configuration getEffectiveConfiguration() {
- Configuration effCfg = this.cfg;
- if (effCfg == null) {
- //By default, enable font auto-detection if no cfg is given
- boolean autoFonts = getAutoFontsDefault();
- if (hints.containsKey(KEY_AUTO_FONTS)) {
- autoFonts = (Boolean) hints.get(KEY_AUTO_FONTS);
- }
- if (autoFonts) {
- DefaultConfiguration c = new DefaultConfiguration("cfg");
- DefaultConfiguration fonts = new DefaultConfiguration("fonts");
- c.addChild(fonts);
- DefaultConfiguration autodetect = new DefaultConfiguration("auto-detect");
- fonts.addChild(autodetect);
- effCfg = c;
- }
- }
- return effCfg;
- }
-
- /**
- * Returns the logger associated with this transcoder. It returns a
- * SimpleLog if no logger has been explicitly set.
- * @return Logger the logger for the transcoder.
- */
- protected final Log getLogger() {
- if (this.logger == null) {
- this.logger = new SimpleLog("FOP/Transcoder");
- }
- return this.logger;
- }
-
- /**
- * Creates a {@link DocumentFactory} that is used to create an SVG DOM
- * tree. The specified DOM Implementation is ignored and the Batik
- * SVG DOM Implementation is automatically used.
- *
- * @param domImpl the DOM Implementation (not used)
- * @param parserClassname the XML parser classname
- * @return the document factory
- */
- protected DocumentFactory createDocumentFactory(DOMImplementation domImpl,
- String parserClassname) {
- final FOPSAXSVGDocumentFactory factory
- = new FOPSAXSVGDocumentFactory(parserClassname);
- if (this.resolver != null) {
- factory.setAdditionalEntityResolver(this.resolver);
- }
- return factory;
- }
-
- /**
- * Indicates whether text should be stroked rather than painted using text operators. Stroking
- * text (also referred to as "painting as shapes") can used in situations where the quality of
- * text output is not satisfying. The downside of the work-around: The generated file will
- * likely become bigger and you will lose copy/paste functionality for certain output formats
- * such as PDF.
- * @return true if text should be stroked rather than painted using text operators
- */
- protected boolean isTextStroked() {
- boolean stroke = false;
- if (hints.containsKey(KEY_STROKE_TEXT)) {
- stroke = (Boolean) hints.get(KEY_STROKE_TEXT);
- }
- return stroke;
- }
-
- /**
- * Returns the device resolution that has been set up.
- * @return the device resolution (in dpi)
- */
- protected float getDeviceResolution() {
- if (hints.containsKey(KEY_DEVICE_RESOLUTION)) {
- return (Float) hints.get(KEY_DEVICE_RESOLUTION);
- } else {
- return GraphicsConstants.DEFAULT_DPI;
- }
- }
-
- /**
- * Returns the ImageManager to be used by the transcoder.
- * @return the image manager
- */
- protected ImageManager getImageManager() {
- return this.imageManager;
- }
-
- /**
- * Returns the ImageSessionContext to be used by the transcoder.
- * @return the image session context
- */
- protected ImageSessionContext getImageSessionContext() {
- return this.imageSessionContext;
- }
-
- /**
- * Sets up the image infrastructure (the image loading framework).
- * @param baseURI the base URI of the current document
- */
- protected void setupImageInfrastructure(final String baseURI) {
- final ImageContext imageContext = new ImageContext() {
- public float getSourceResolution() {
- return UnitConv.IN2MM / userAgent.getPixelUnitToMillimeter();
- }
- };
- this.imageManager = new ImageManager(imageContext);
- this.imageSessionContext = new AbstractImageSessionContext() {
-
- public ImageContext getParentContext() {
- return imageContext;
- }
-
- public float getTargetResolution() {
- return getDeviceResolution();
- }
-
- public Source resolveURI(String uri) {
- try {
- ParsedURL url = new ParsedURL(baseURI, uri);
- InputStream in = url.openStream();
- StreamSource source = new StreamSource(in, url.toString());
- return source;
- } catch (IOException ioe) {
- userAgent.displayError(ioe);
- return null;
- }
- }
-
- };
- }
-
- // --------------------------------------------------------------------
- // FOP's default error handler (for transcoders)
- // --------------------------------------------------------------------
-
- /**
- * This is the default transcoder error handler for FOP. It logs error
- * to an Commons Logger instead of to System.out. The remaining behaviour
- * is the same as Batik's DefaultErrorHandler.
- */
- protected class FOPErrorHandler implements ErrorHandler {
-
- /**
- * {@inheritDoc}
- */
- public void error(TranscoderException te)
- throws TranscoderException {
- getLogger().error(te.getMessage());
- }
-
- /**
- * {@inheritDoc}
- */
- public void fatalError(TranscoderException te)
- throws TranscoderException {
- throw te;
- }
-
- /**
- * {@inheritDoc}
- */
- public void warning(TranscoderException te)
- throws TranscoderException {
- getLogger().warn(te.getMessage());
- }
-
- }
-
- // --------------------------------------------------------------------
- // UserAgent implementation
- // --------------------------------------------------------------------
-
- /**
- * A user agent implementation for FOP's Transcoders.
- */
- protected class FOPTranscoderUserAgent extends SVGAbstractTranscoderUserAgent {
-
- private FOPFontFamilyResolver fontFamilyResolver;
-
- /**
- * Displays the specified error message using the {@link ErrorHandler}.
- * @param message the message to display
- */
- public void displayError(String message) {
- try {
- getErrorHandler().error(new TranscoderException(message));
- } catch (TranscoderException ex) {
- throw new RuntimeException();
- }
- }
-
- /**
- * Displays the specified error using the {@link ErrorHandler}.
- * @param e the exception to display
- */
- public void displayError(Exception e) {
- try {
- getErrorHandler().error(new TranscoderException(e));
- } catch (TranscoderException ex) {
- throw new RuntimeException();
- }
- }
-
- /**
- * Displays the specified message using the {@link ErrorHandler}.
- * @param message the message to display
- */
- public void displayMessage(String message) {
- getLogger().info(message);
- }
-
- /**
- * Returns the pixel to millimeter conversion factor specified in the
- * {@link TranscodingHints} or 0.3528 if any.
- * @return the pixel unit to millimeter factor
- */
- public float getPixelUnitToMillimeter() {
- Object key = ImageTranscoder.KEY_PIXEL_UNIT_TO_MILLIMETER;
- if (getTranscodingHints().containsKey(key)) {
- return (Float) getTranscodingHints().get(key);
- } else {
- // return 0.3528f; // 72 dpi
- return UnitConv.IN2MM / 96; //96dpi = 0.2645833333333333333f;
- }
- }
-
- /**
- * Get the media for this transcoder. Which is always print.
- * @return PDF media is "print"
- */
- public String getMedia() {
- return "print";
- }
-
- public void setFontFamilyResolver(FOPFontFamilyResolver resolver) {
- fontFamilyResolver = resolver;
- }
-
- @Override
- public FontFamilyResolver getFontFamilyResolver() {
- return fontFamilyResolver;
- }
-
- }
-
- }
|