123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608 |
- /*
- * Copyright 2006 The Apache Software Foundation.
- *
- * Licensed 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.apps;
-
- import java.io.File;
- import java.io.IOException;
- import java.io.OutputStream;
- import java.net.MalformedURLException;
- import java.util.List;
-
- import javax.xml.transform.Source;
- import javax.xml.transform.TransformerException;
- import javax.xml.transform.URIResolver;
-
- import org.apache.avalon.framework.configuration.Configuration;
- import org.apache.avalon.framework.configuration.ConfigurationException;
- import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
- import org.apache.commons.logging.Log;
- import org.apache.commons.logging.LogFactory;
- import org.apache.fop.fo.ElementMapping;
- import org.apache.fop.fo.ElementMappingRegistry;
- import org.apache.fop.hyphenation.HyphenationTreeResolver;
- import org.apache.fop.image.ImageFactory;
- import org.apache.fop.layoutmgr.LayoutManagerMaker;
- import org.apache.fop.render.RendererFactory;
- import org.apache.fop.render.XMLHandlerRegistry;
- import org.apache.fop.util.ContentHandlerFactoryRegistry;
- import org.xml.sax.SAXException;
-
- /**
- * Factory class which instantiates new Fop and FOUserAgent instances. This class also holds
- * environmental information and configuration used by FOP. Information that may potentially be
- * different for each rendering run can be found and managed in the FOUserAgent.
- */
- public class FopFactory {
-
- /** Defines the default source resolution (72dpi) for FOP */
- private static final float DEFAULT_SOURCE_RESOLUTION = 72.0f; //dpi
- /** Defines the default page-height */
- private static final String DEFAULT_PAGE_HEIGHT = "11in";
- /** Defines the default page-width */
- private static final String DEFAULT_PAGE_WIDTH = "8.26in";
-
- /** logger instance */
- private static Log log = LogFactory.getLog(FopFactory.class);
-
- /** Factory for Renderers and FOEventHandlers */
- private RendererFactory rendererFactory = new RendererFactory();
-
- /** Registry for XML handlers */
- private XMLHandlerRegistry xmlHandlers = new XMLHandlerRegistry();
-
- /** The registry for ElementMapping instances */
- private ElementMappingRegistry elementMappingRegistry;
-
- /** The registry for ContentHandlerFactory instance */
- private ContentHandlerFactoryRegistry contentHandlerFactoryRegistry
- = new ContentHandlerFactoryRegistry();
-
- /** Our default resolver if none is set */
- private URIResolver foURIResolver = new FOURIResolver();
- /** A user settable URI Resolver */
- private URIResolver uriResolver = null;
-
- /** The resolver for user-supplied hyphenation patterns */
- private HyphenationTreeResolver hyphResolver;
-
- private ImageFactory imageFactory = new ImageFactory();
-
- /** user configuration */
- private Configuration userConfig = null;
-
- /** The base URL for all font URL resolutions */
- private String fontBaseURL;
-
- /**
- * FOP has the ability, for some FO's, to continue processing even if the
- * input XSL violates that FO's content model. This is the default
- * behavior for FOP. However, this flag, if set, provides the user the
- * ability for FOP to halt on all content model violations if desired.
- */
- private boolean strictValidation = true;
-
- /** Allows enabling kerning on the base 14 fonts, default is false */
- private boolean enableBase14Kerning = false;
-
- /** Source resolution in dpi */
- private float sourceResolution = DEFAULT_SOURCE_RESOLUTION;
- private String pageHeight = DEFAULT_PAGE_HEIGHT;
- private String pageWidth = DEFAULT_PAGE_WIDTH;
-
- /** @see #setBreakIndentInheritanceOnReferenceAreaBoundary(boolean) */
- private boolean breakIndentInheritanceOnReferenceAreaBoundary = false;
-
- /** Additional fo.ElementMapping subclasses set by user */
- private List additionalElementMappings = null;
-
- /** Optional overriding LayoutManagerMaker */
- private LayoutManagerMaker lmMakerOverride = null;
-
- /**
- * Main constructor.
- */
- protected FopFactory() {
- this.elementMappingRegistry = new ElementMappingRegistry(this);
- }
-
- /**
- * Returns a new FopFactory instance.
- * @return the requested FopFactory instance.
- */
- public static FopFactory newInstance() {
- return new FopFactory();
- }
-
- /**
- * Returns a new FOUserAgent instance. Use the FOUserAgent to configure special values that
- * are particular to a rendering run. Don't reuse instances over multiple rendering runs but
- * instead create a new one each time and reuse the FopFactory.
- * @return the newly created FOUserAgent instance initialized with default values
- */
- public FOUserAgent newFOUserAgent() {
- FOUserAgent userAgent = new FOUserAgent(this);
- return userAgent;
- }
-
- /**
- * Returns a new {@link Fop} instance. FOP will be configured with a default user agent
- * instance.
- * <p>
- * MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
- * use the constants defined in {@link MimeConstants}.
- * @param outputFormat the MIME type of the output format to use (ex. "application/pdf").
- * @return the new Fop instance
- * @throws FOPException when the constructor fails
- */
- public Fop newFop(String outputFormat) throws FOPException {
- return new Fop(outputFormat, newFOUserAgent());
- }
-
- /**
- * Returns a new {@link Fop} instance. Use this factory method if you want to configure this
- * very rendering run, i.e. if you want to set some metadata like the title and author of the
- * document you want to render. In that case, create a new {@link FOUserAgent}
- * instance using {@link #newFOUserAgent()}.
- * <p>
- * MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
- * use the constants defined in {@link MimeConstants}.
- * @param outputFormat the MIME type of the output format to use (ex. "application/pdf").
- * @param userAgent the user agent that will be used to control the rendering run
- * @return the new Fop instance
- * @throws FOPException when the constructor fails
- */
- public Fop newFop(String outputFormat, FOUserAgent userAgent) throws FOPException {
- if (userAgent == null) {
- throw new NullPointerException("The userAgent parameter must not be null!");
- }
- return new Fop(outputFormat, userAgent);
- }
-
- /**
- * Returns a new {@link Fop} instance. FOP will be configured with a default user agent
- * instance. Use this factory method if your output type requires an output stream.
- * <p>
- * MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
- * use the constants defined in {@link MimeConstants}.
- * @param outputFormat the MIME type of the output format to use (ex. "application/pdf").
- * @param stream the output stream
- * @return the new Fop instance
- * @throws FOPException when the constructor fails
- */
- public Fop newFop(String outputFormat, OutputStream stream) throws FOPException {
- return new Fop(outputFormat, newFOUserAgent(), stream);
- }
-
- /**
- * Returns a new {@link Fop} instance. Use this factory method if your output type
- * requires an output stream and you want to configure this very rendering run,
- * i.e. if you want to set some metadata like the title and author of the document
- * you want to render. In that case, create a new {@link FOUserAgent} instance
- * using {@link #newFOUserAgent()}.
- * <p>
- * MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
- * use the constants defined in {@link MimeConstants}.
- * @param outputFormat the MIME type of the output format to use (ex. "application/pdf").
- * @param userAgent the user agent that will be used to control the rendering run
- * @param stream the output stream
- * @return the new Fop instance
- * @throws FOPException when the constructor fails
- */
- public Fop newFop(String outputFormat, FOUserAgent userAgent, OutputStream stream)
- throws FOPException {
- if (userAgent == null) {
- throw new NullPointerException("The userAgent parameter must not be null!");
- }
- return new Fop(outputFormat, userAgent, stream);
- }
-
- /**
- * Returns a new {@link Fop} instance. Use this factory method if you want to supply your
- * own {@link org.apache.fop.render.Renderer Renderer} or
- * {@link org.apache.fop.fo.FOEventHandler FOEventHandler}
- * instance instead of the default ones created internally by FOP.
- * @param userAgent the user agent that will be used to control the rendering run
- * @return the new Fop instance
- * @throws FOPException when the constructor fails
- */
- public Fop newFop(FOUserAgent userAgent) throws FOPException {
- if (userAgent.getRendererOverride() == null
- && userAgent.getFOEventHandlerOverride() == null) {
- throw new IllegalStateException("Either the overriding renderer or the overriding"
- + " FOEventHandler must be set when this factory method is used!");
- }
- return newFop(null, userAgent);
- }
-
- /** @return the RendererFactory */
- public RendererFactory getRendererFactory() {
- return this.rendererFactory;
- }
-
- /** @return the XML handler registry */
- public XMLHandlerRegistry getXMLHandlerRegistry() {
- return this.xmlHandlers;
- }
-
- /** @return the element mapping registry */
- public ElementMappingRegistry getElementMappingRegistry() {
- return this.elementMappingRegistry;
- }
-
- /** @return the content handler factory registry */
- public ContentHandlerFactoryRegistry getContentHandlerFactoryRegistry() {
- return this.contentHandlerFactoryRegistry;
- }
-
- /** @return the image factory */
- public ImageFactory getImageFactory() {
- return this.imageFactory;
- }
-
- /**
- * Add the element mapping with the given class name.
- * @param elementMapping the class name representing the element mapping.
- */
- public void addElementMapping(ElementMapping elementMapping) {
- if (additionalElementMappings == null) {
- additionalElementMappings = new java.util.ArrayList();
- }
- additionalElementMappings.add(elementMapping);
- }
-
- /**
- * Returns the List of user-added ElementMapping class names
- * @return List of Strings holding ElementMapping names.
- */
- public List getAdditionalElementMappings() {
- return additionalElementMappings;
- }
-
- /**
- * Sets an explicit LayoutManagerMaker instance which overrides the one
- * defined by the AreaTreeHandler.
- * @param lmMaker the LayoutManagerMaker instance
- */
- public void setLayoutManagerMakerOverride(LayoutManagerMaker lmMaker) {
- this.lmMakerOverride = lmMaker;
- }
-
- /**
- * Returns the overriding LayoutManagerMaker instance, if any.
- * @return the overriding LayoutManagerMaker or null
- */
- public LayoutManagerMaker getLayoutManagerMakerOverride() {
- return this.lmMakerOverride;
- }
-
- /**
- * Sets the font base URL.
- * @param fontBaseURL font base URL
- */
- public void setFontBaseURL(String fontBaseURL) {
- this.fontBaseURL = fontBaseURL;
- }
-
- /** @return the font base URL */
- public String getFontBaseURL() {
- return this.fontBaseURL;
- }
-
- /**
- * Sets the URI Resolver. It is used for resolving factory-level URIs like hyphenation
- * patterns and as backup for URI resolution performed during a rendering run.
- * @param resolver the new URI resolver
- */
- public void setURIResolver(URIResolver resolver) {
- this.uriResolver = resolver;
- }
-
- /**
- * Returns the URI Resolver.
- * @return the URI Resolver
- */
- public URIResolver getURIResolver() {
- return this.uriResolver;
- }
-
- /** @return the HyphenationTreeResolver for resolving user-supplied hyphenation patterns. */
- public HyphenationTreeResolver getHyphenationTreeResolver() {
- return this.hyphResolver;
- }
-
- /**
- * Activates strict XSL content model validation for FOP
- * Default is false (FOP will continue processing where it can)
- * @param validateStrictly true to turn on strict validation
- */
- public void setStrictValidation(boolean validateStrictly) {
- this.strictValidation = validateStrictly;
- }
-
- /**
- * Returns whether FOP is strictly validating input XSL
- * @return true of strict validation turned on, false otherwise
- */
- public boolean validateStrictly() {
- return strictValidation;
- }
-
- /**
- * @return true if the indent inheritance should be broken when crossing reference area
- * boundaries (for more info, see the javadoc for the relative member variable)
- */
- public boolean isBreakIndentInheritanceOnReferenceAreaBoundary() {
- return breakIndentInheritanceOnReferenceAreaBoundary;
- }
-
- /**
- * Controls whether to enable a feature that breaks indent inheritance when crossing
- * reference area boundaries.
- * <p>
- * This flag controls whether FOP will enable special code that breaks property
- * inheritance for start-indent and end-indent when the evaluation of the inherited
- * value would cross a reference area. This is described under
- * http://wiki.apache.org/xmlgraphics-fop/IndentInheritance as is intended to
- * improve interoperability with commercial FO implementations and to produce
- * results that are more in line with the expectation of unexperienced FO users.
- * Note: Enabling this features violates the XSL specification!
- * @param value true to enable the feature
- */
- public void setBreakIndentInheritanceOnReferenceAreaBoundary(boolean value) {
- this.breakIndentInheritanceOnReferenceAreaBoundary = value;
- }
-
- /** @return true if kerning on base 14 fonts is enabled */
- public boolean isBase14KerningEnabled() {
- return this.enableBase14Kerning;
- }
-
- /**
- * Controls whether kerning is activated on base 14 fonts.
- * @param value true if kerning should be activated
- */
- public void setBase14KerningEnabled(boolean value) {
- this.enableBase14Kerning = value;
- }
-
- /** @return the resolution for resolution-dependant input */
- public float getSourceResolution() {
- return this.sourceResolution;
- }
-
- /**
- * Returns the conversion factor from pixel units to millimeters. This
- * depends on the desired source resolution.
- * @return float conversion factor
- * @see #getSourceResolution()
- */
- public float getSourcePixelUnitToMillimeter() {
- return 25.4f / getSourceResolution();
- }
-
- /**
- * Sets the source resolution in dpi. This value is used to interpret the pixel size
- * of source documents like SVG images and bitmap images without resolution information.
- * @param dpi resolution in dpi
- */
- public void setSourceResolution(int dpi) {
- this.sourceResolution = dpi;
- }
-
- /**
- * Gets the default page-height to use as fallback,
- * in case page-height="auto"
- *
- * @return the page-height, as a String
- */
- public String getPageHeight() {
- return this.pageHeight;
- }
-
- /**
- * Sets the page-height to use as fallback, in case
- * page-height="auto"
- *
- * @param pageHeight page-height as a String
- */
- public void setPageHeight(String pageHeight) {
- this.pageHeight = pageHeight;
- }
-
- /**
- * Gets the default page-width to use as fallback,
- * in case page-width="auto"
- *
- * @return the page-width, as a String
- */
- public String getPageWidth() {
- return this.pageWidth;
- }
-
- /**
- * Sets the page-width to use as fallback, in case
- * page-width="auto"
- *
- * @param pageWidth page-width as a String
- */
- public void setPageWidth(String pageWidth) {
- this.pageWidth = pageWidth;
- }
-
- //------------------------------------------- Configuration stuff
-
- /**
- * Set the user configuration.
- * @param userConfigFile the configuration file
- * @throws IOException if an I/O error occurs
- * @throws SAXException if a parsing error occurs
- */
- public void setUserConfig(File userConfigFile)
- throws SAXException, IOException {
- try {
- DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
- setUserConfig(cfgBuilder.buildFromFile(userConfigFile));
- } catch (ConfigurationException cfge) {
- log.error("Error loading configuration: "
- + cfge.getMessage());
- }
- }
-
- /**
- * Set the user configuration from an URI.
- * @param uri the URI to the configuration file
- * @throws IOException if an I/O error occurs
- * @throws SAXException if a parsing error occurs
- */
- public void setUserConfig(String uri)
- throws SAXException, IOException {
- try {
- DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
- setUserConfig(cfgBuilder.build(uri));
- } catch (ConfigurationException cfge) {
- log.error("Error loading configuration: "
- + cfge.getMessage());
- }
- }
-
- /**
- * Set the user configuration.
- * @param userConfig configuration
- */
- public void setUserConfig(Configuration userConfig) {
- this.userConfig = userConfig;
- try {
- initUserConfig();
- } catch (ConfigurationException cfge) {
- log.error("Error initializing factory configuration: "
- + cfge.getMessage());
- }
- }
-
- /**
- * Get the user configuration.
- * @return the user configuration
- */
- public Configuration getUserConfig() {
- return userConfig;
- }
-
- /**
- * Initializes user agent settings from the user configuration
- * file, if present: baseURL, resolution, default page size,...
- *
- * @throws ConfigurationException when there is an entry that
- * misses the required attribute
- */
- public void initUserConfig() throws ConfigurationException {
- log.debug("Initializing User Agent Configuration");
- setFontBaseURL(getBaseURLfromConfig(userConfig, "font-base"));
- final String hyphBase = getBaseURLfromConfig(userConfig, "hyphenation-base");
- if (hyphBase != null) {
- this.hyphResolver = new HyphenationTreeResolver() {
- public Source resolve(String href) {
- return resolveURI(href, hyphBase);
- }
- };
- }
- if (userConfig.getChild("source-resolution", false) != null) {
- this.sourceResolution
- = userConfig.getChild("source-resolution").getValueAsFloat(
- DEFAULT_SOURCE_RESOLUTION);
- log.info("Source resolution set to: " + sourceResolution
- + "dpi (px2mm=" + getSourcePixelUnitToMillimeter() + ")");
- }
- if (userConfig.getChild("strict-validation", false) != null) {
- this.strictValidation = userConfig.getChild("strict-validation").getValueAsBoolean();
- }
- if (userConfig.getChild("break-indent-inheritance", false) != null) {
- this.breakIndentInheritanceOnReferenceAreaBoundary
- = userConfig.getChild("break-indent-inheritance").getValueAsBoolean();
- }
- Configuration pageConfig = userConfig.getChild("default-page-settings");
- if (pageConfig.getAttribute("height", null) != null) {
- setPageHeight(pageConfig.getAttribute("height"));
- log.info("Default page-height set to: " + pageHeight);
- }
- if (pageConfig.getAttribute("width", null) != null) {
- setPageWidth(pageConfig.getAttribute("width"));
- log.info("Default page-width set to: " + pageWidth);
- }
- }
-
- /**
- * Retrieves and verifies a base URL.
- * @param cfg The Configuration object to retrieve the base URL from
- * @param name the element name for the base URL
- * @return the requested base URL or null if not available
- */
- public static String getBaseURLfromConfig(Configuration cfg, String name) {
- if (cfg.getChild(name, false) != null) {
- try {
- String cfgBaseDir = cfg.getChild(name).getValue(null);
- if (cfgBaseDir != null) {
- File dir = new File(cfgBaseDir);
- if (dir.isDirectory()) {
- cfgBaseDir = dir.toURL().toExternalForm();
- }
- }
- log.info(name + " set to: " + cfgBaseDir);
- return cfgBaseDir;
- } catch (MalformedURLException mue) {
- log.error("Base URL in user config is malformed!");
- }
- }
- return null;
- }
-
- //------------------------------------------- URI resolution
-
- /**
- * Attempts to resolve the given URI.
- * Will use the configured resolver and if not successful fall back
- * to the default resolver.
- * @param uri URI to access
- * @param base the base URI to resolve against
- * @return A {@link javax.xml.transform.Source} object, or null if the URI
- * cannot be resolved.
- * @see org.apache.fop.apps.FOURIResolver
- */
- public Source resolveURI(String uri, String base) {
- Source source = null;
- if (uriResolver != null) {
- try {
- source = uriResolver.resolve(uri, base);
- } catch (TransformerException te) {
- log.error("Attempt to resolve URI '" + uri + "' failed: ", te);
- }
- }
- if (source == null) {
- // URI Resolver not configured or returned null, use default resolver
- try {
- source = foURIResolver.resolve(uri, base);
- } catch (TransformerException te) {
- log.error("Attempt to resolve URI '" + uri + "' failed: ", te);
- }
- }
- return source;
- }
-
-
-
- }
|