Metadata

Overview - - Support for PDF/A is available beginning with version 0.92. -

PDF/A is a standard which turns PDF into an "electronic document file format for long-term preservation". PDF/A-1 is the first part of the diff --git a/src/documentation/content/xdocs/faq.xml b/src/documentation/content/xdocs/faq.xml index a75cd41e0..ac2693d8b 100644 --- a/src/documentation/content/xdocs/faq.xml +++ b/src/documentation/content/xdocs/faq.xml @@ -385,6 +385,47 @@

+ + I get a SAXException: Mismatch: page-sequence vs. root + (or similar). + +

+ The full exception usually looks similar to this: +

+ Mismatch: page-sequence (http://www.w3.org/1999/XSL/Format) vs. root + (http://www.w3.org/1999/XSL/Format) +

+ This exception is usually a follow-up error after another exception. Sometimes + the original exception gets swallowed by Xalan's default ErrorListener + (should be fixed in the latest Xalan release). +

+ The work-around is to set an explicit ErrorListener on the + Transformer. The ErrorListener can be as simple as this: +

+ + + Problems with FOP output @@ -551,8 +592,10 @@ Check the following:

text flows into adjacent cells/block, obscuring stuff there.

- Clipping as specified by the overflow="hidden" is not yet - implemented. If you have long words overflowing table cells, try to + Since the overflow property doesn't apply to table-cell, you + can wrap the cell content in a block-container and specify + overflow="hidden" there. Alternatively, + if you have long words overflowing table cells, try to get them hyphenated. Artificial names like product identifications or long numbers usually aren't hyphenated. You can try special processing at XSLT level, like @@ -574,6 +617,15 @@ Check the following:

XSL list archive for how to perform these tasks.

+ If your text is not hyphenated at all and overflows the cell, please check + if you've specified keep-together="always" on the table-cell + or one of its parent elements. keep-together="always" implicitely + also sets keep-together.within-line="always" which forbids FOP + to break the text into multiple lines. This is important as FOP supports inline-level + keeps since version 0.94. It's a good idea not to use the shorthand + keep-together="always" at all! +

diff --git a/src/documentation/content/xdocs/site.xml b/src/documentation/content/xdocs/site.xml index 5ebdef322..d87b68aab 100644 --- a/src/documentation/content/xdocs/site.xml +++ b/src/documentation/content/xdocs/site.xml @@ -123,6 +123,7 @@ + @@ -157,6 +158,7 @@ + diff --git a/src/documentation/content/xdocs/trunk/metadata.xml b/src/documentation/content/xdocs/trunk/metadata.xml new file mode 100644 index 000000000..8c273fff5 --- /dev/null +++ b/src/documentation/content/xdocs/trunk/metadata.xml @@ -0,0 +1,243 @@ + + + + + +

+ Metadata +

+ +

+ Overview +

+ Document metadata is an important tool for categorizing and finding documents. + Various formats support different kinds of metadata representation and to + different levels. One of the more popular and flexible means of representing + document or object metadata is + XMP (eXtensible Metadata Platform, specified by Adobe). + PDF 1.4 introduced the use of XMP. The XMP specification lists recommendation for + embedding XMP metdata in other document and image formats. Given its flexibility it makes + sense to make use this approach in the XSL-FO context. Unfortunately, unlike SVG which + also refers to XMP, XSL-FO doesn't recommend a preferred way of specifying document and + object metadata. Therefore, there's no portable way to represent metadata in XSL-FO + documents. Each implementation does it differently. +

+ Embedding XMP in an XSL-FO document +

+ As noted above, there's no officially recommended way to embed metadata in XSL-FO. + Apache FOP supports embedding XMP in XSL-FO. Currently, only support for document-level + metadata is implemented. Object-level metadata will be implemented when there's + interest. +

+ Document-level metadata can be specified in the fo:declarations element. + XMP specification recommends to use x:xmpmeta, rdf:RDF, and + rdf:Description elements as shown in example below. Both + x:xmpmeta and rdf:RDF elements are recognized as the top-level + element introducing an XMP fragment (as per the XMP specification). +

+ Example + + + + + + + Document title + Document author + Document subject + + + + Tool used to make the PDF + + + + + + + fo:declarations must be declared after + fo:layout-master-set and before the first page-sequence. + +

+ Implementation in Apache FOP +

+ Currently, XMP support is only available for PDF output. +

+ Originally, you could set some metadata information through FOP's FOUserAgent by + using its set*() methods (like setTitle(String) or setAuthor(String). These values are + directly used to set value in the PDF Info object. Since PDF 1.4, adding metadata as an + XMP document to a PDF is possible. That means that there are now two mechanisms in PDF + that hold metadata. +

+ Apache FOP now synchronizes the Info and the Metadata object in PDF, i.e. when you + set the title and the author through the FOUserAgent, the two values will end up in + the (old) Info object and in the new Metadata object as XMP content. If instead of + FOUserAgent, you embed XMP metadata in the XSL-FO document (as shown above), the + XMP metadata will be used as-is in the PDF Metadata object and some values from the + XMP metadata will be copied to the Info object to maintain backwards-compatibility + for PDF readers that don't support XMP metadata. +

+ The mapping between the Info and the Metadata object used by Apache FOP comes from + the PDF/A-1 specification. + For convenience, here's the mapping table: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Document information dictionary		XMP
Entry	PDF type	Property	XMP type	Category
Title	text string	dc:title	Text	External
Author	text string	dc:creator	seq Text	External
Subject	text string	dc:description["x-default"]	Text	External
Keywords	text string	pdf:Keywords	Text	External
Creator	text string	xmp:CreatorTool	Text	External
Producer	text string	pdf:Producer	Text	Internal
CreationDate	date	xmp:CreationDate	Date	Internal
ModDate	date	xmp:ModifyDate	Date	Internal

+ + "Internal" in the Category column means that the user should not set this value. + It is set by the application. + + + The "Subject" used to be mapped to dc:subject in the initial publication of + PDF/A-1 (ISO 19005-1). In the + Technical Corrigendum 1 + this was changed to map to dc:description["x-default"]. + +

+ Namespaces +

+ Metadata is made of property sets where each property set uses a different namespace URI. +

+ The following is a listing of namespaces that Apache FOP recognizes and acts upon, + mostly to synchronize the XMP metadata with the PDF Info dictionary: +

+ + + + + + + + + + + + + + + + + + + + + +

Set/Schema	Namespace Prefix	Namespace URI
Dublin Core	dc	http://purl.org/dc/elements/1.1/
XMP Basic	xmp	http://ns.adobe.com/xap/1.0/
Adobe PDF Schema	pdf	http://ns.adobe.com/pdf/1.3/

+ Please refer to the XMP Specification + for information on other metadata namespaces. +

+ Property sets (Namespaces) not listed here are simply passed through to the final + document (if supported). That is useful if you want to specify a custom metadata + schema. +

+ Links +

+ + diff --git a/src/documentation/content/xdocs/trunk/pdfa.xml b/src/documentation/content/xdocs/trunk/pdfa.xml index 1b3b75561..bfa1ae33e 100644 --- a/src/documentation/content/xdocs/trunk/pdfa.xml +++ b/src/documentation/content/xdocs/trunk/pdfa.xml @@ -28,9 +28,6 @@

Overview - - Support for PDF/A is available beginning with version 0.92. -

PDF/A is a standard which turns PDF into an "electronic document file format for long-term preservation". PDF/A-1 is the first part of the diff --git a/src/java/org/apache/fop/apps/FOURIResolver.java b/src/java/org/apache/fop/apps/FOURIResolver.java index 1f4425a95..58ae6e8e6 100644 --- a/src/java/org/apache/fop/apps/FOURIResolver.java +++ b/src/java/org/apache/fop/apps/FOURIResolver.java @@ -34,14 +34,12 @@ import javax.xml.transform.stream.StreamSource; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; - import org.apache.xmlgraphics.util.io.Base64EncodeStream; - -import org.apache.fop.util.DataURIResolver; +import org.apache.xmlgraphics.util.uri.CommonURIResolver; /** * Provides FOP specific URI resolution. This is the default URIResolver - * {@link FOUserAgent} will use unless overidden. + * {@link FOUserAgent} will use unless overridden. * * @see javax.xml.transform.URIResolver */ @@ -50,8 +48,8 @@ public class FOURIResolver implements javax.xml.transform.URIResolver { // log private Log log = LogFactory.getLog("FOP"); - /** URIResolver for RFC 2397 data URLs */ - private URIResolver dataURIResolver = new DataURIResolver(); + /** Common URIResolver */ + private CommonURIResolver commonURIResolver = new CommonURIResolver(); /** A user settable URI Resolver */ private URIResolver uriResolver = null; @@ -152,7 +150,7 @@ public class FOURIResolver implements javax.xml.transform.URIResolver { // data URLs can be quite long so evaluate early and don't try to build a File // (can lead to problems) - source = dataURIResolver.resolve(href, base); + source = commonURIResolver.resolve(href, base); // Custom uri resolution if (source == null && uriResolver != null) { diff --git a/src/java/org/apache/fop/fo/properties/PropertyCache.java b/src/java/org/apache/fop/fo/properties/PropertyCache.java index f834a78ae..d472b574c 100644 --- a/src/java/org/apache/fop/fo/properties/PropertyCache.java +++ b/src/java/org/apache/fop/fo/properties/PropertyCache.java @@ -33,9 +33,12 @@ import java.lang.ref.WeakReference; */ public final class PropertyCache { + private static final int SEGMENT_COUNT = 32; //0x20 + private static final int INITIAL_BUCKET_COUNT = SEGMENT_COUNT; + /** bitmask to apply to the hash to get to the * corresponding cache segment */ - private static final int SEGMENT_MASK = 0x1F; + private static final int SEGMENT_MASK = SEGMENT_COUNT - 1; //0x1F /** * Indicates whether the cache should be used at all * Can be controlled by the system property: @@ -44,13 +47,13 @@ public final class PropertyCache { private final boolean useCache; /** the segments array (length = 32) */ - private CacheSegment[] segments = new CacheSegment[SEGMENT_MASK + 1]; + private CacheSegment[] segments = new CacheSegment[SEGMENT_COUNT]; /** the table of hash-buckets */ - private CacheEntry[] table = new CacheEntry[8]; + private CacheEntry[] table = new CacheEntry[INITIAL_BUCKET_COUNT]; private Class runtimeType; - final boolean[] votesForRehash = new boolean[SEGMENT_MASK + 1]; + private boolean[] votesForRehash = new boolean[SEGMENT_COUNT]; /* same hash function as used by java.util.HashMap */ private static int hash(Object x) { @@ -72,53 +75,61 @@ public final class PropertyCache { } /* Class modeling a cached entry */ - private final class CacheEntry extends WeakReference { - volatile CacheEntry nextEntry; - final int hash; + private static class CacheEntry extends WeakReference { + private volatile CacheEntry nextEntry; + private final int hash; /* main constructor */ public CacheEntry(Object p, CacheEntry nextEntry, ReferenceQueue refQueue) { super(p, refQueue); this.nextEntry = nextEntry; - this.hash = p.hashCode(); + this.hash = hash(p); + } + + /* main constructor */ + public CacheEntry(Object p, CacheEntry nextEntry) { + super(p); + this.nextEntry = nextEntry; + this.hash = hash(p); } } /* Wrapper objects to synchronize on */ - private final class CacheSegment { + private static class CacheSegment { private int count = 0; - private volatile ReferenceQueue staleEntries = new ReferenceQueue(); } private void cleanSegment(int segmentIndex) { - CacheEntry entry; CacheSegment segment = segments[segmentIndex]; - int bucketIndex; + int oldCount = segment.count; - while ((entry = (CacheEntry) segment.staleEntries.poll()) != null) { - bucketIndex = hash(entry.hash) & (table.length - 1); - /* remove obsolete entry */ - /* 1. move to the corresponding entry */ + /* clean all buckets in this segment */ + for (int bucketIndex = segmentIndex; + bucketIndex < table.length; + bucketIndex += SEGMENT_COUNT) { CacheEntry prev = null; - CacheEntry e = table[bucketIndex]; - while (e != null - && e.nextEntry != null - && e.hash != entry.hash) { - prev = e; - e = e.nextEntry; + CacheEntry entry = table[bucketIndex]; + if (entry == null) { + continue; } - if (e != null) { - /* 2. remove reference from the chain */ - if (prev == null) { - table[bucketIndex] = e.nextEntry; + do { + if (entry.get() == null) { + if (prev == null) { + table[bucketIndex] = entry.nextEntry; + } else { + prev.nextEntry = entry.nextEntry; + } + segment.count--; + assert segment.count >= 0; } else { - prev.nextEntry = e.nextEntry; + prev = entry; } - segment.count--; - } + entry = entry.nextEntry; + } while (entry != null); } + synchronized (votesForRehash) { if (oldCount > segment.count) { votesForRehash[segmentIndex] = false; @@ -129,7 +140,7 @@ public final class PropertyCache { /* first time for this segment */ votesForRehash[segmentIndex] = true; int voteCount = 0; - for (int i = SEGMENT_MASK + 1; --i >= 0; ) { + for (int i = SEGMENT_MASK + 1; --i >= 0;) { if (votesForRehash[i]) { voteCount++; } @@ -156,14 +167,15 @@ public final class PropertyCache { private void put(Object o) { int hash = hash(o); - CacheSegment segment = segments[hash & SEGMENT_MASK]; + int segmentIndex = hash & SEGMENT_MASK; + CacheSegment segment = segments[segmentIndex]; synchronized (segment) { int index = hash & (table.length - 1); CacheEntry entry = table[index]; if (entry == null) { - entry = new CacheEntry(o, null, segment.staleEntries); + entry = new CacheEntry(o, null); table[index] = entry; segment.count++; } else { @@ -171,14 +183,14 @@ public final class PropertyCache { if (eq(p, o)) { return; } else { - CacheEntry newEntry = new CacheEntry(o, entry, segment.staleEntries); + CacheEntry newEntry = new CacheEntry(o, entry); table[index] = newEntry; segment.count++; } } if (segment.count > (2 * table.length)) { - cleanSegment(hash & SEGMENT_MASK); + cleanSegment(segmentIndex); } } } @@ -195,7 +207,7 @@ public final class PropertyCache { /* try non-synched first */ for (CacheEntry e = entry; e != null; e = e.nextEntry) { - if (e.hash == o.hashCode() + if (e.hash == hash && (q = e.get()) != null && eq(q, o)) { return q; @@ -209,7 +221,7 @@ public final class PropertyCache { synchronized (segment) { entry = table[index]; for (CacheEntry e = entry; e != null; e = e.nextEntry) { - if (e.hash == o.hashCode() + if (e.hash == hash && (q = e.get()) != null && eq(q, o)) { return q; @@ -235,7 +247,7 @@ public final class PropertyCache { /* double the amount of buckets */ int newLength = table.length << 1; if (newLength > 0) { //no overflow? - /* reset segmentcounts */ + /* reset segment counts */ for (int i = segments.length; --i >= 0;) { segments[i].count = 0; } @@ -250,8 +262,7 @@ public final class PropertyCache { if ((o = c.get()) != null) { hash = c.hash; idx = hash & newLength; - newTable[idx] = new CacheEntry(o, newTable[idx], - segments[hash & SEGMENT_MASK].staleEntries); + newTable[idx] = new CacheEntry(o, newTable[idx]); segments[hash & SEGMENT_MASK].count++; } } @@ -313,7 +324,7 @@ public final class PropertyCache { * @param prop the Property instance to check for * @return the cached instance */ - public final Property fetch(Property prop) { + public Property fetch(Property prop) { return (Property) fetch((Object) prop); } @@ -326,7 +337,7 @@ public final class PropertyCache { * @param chy the CommonHyphenation instance to check for * @return the cached instance */ - public final CommonHyphenation fetch(CommonHyphenation chy) { + public CommonHyphenation fetch(CommonHyphenation chy) { return (CommonHyphenation) fetch((Object) chy); } @@ -339,7 +350,7 @@ public final class PropertyCache { * @param cf the CommonFont instance to check for * @return the cached instance */ - public final CommonFont fetch(CommonFont cf) { + public CommonFont fetch(CommonFont cf) { return (CommonFont) fetch((Object) cf); } @@ -352,21 +363,21 @@ public final class PropertyCache { * @param cbpb the CommonBorderPaddingBackground instance to check for * @return the cached instance */ - public final CommonBorderPaddingBackground fetch(CommonBorderPaddingBackground cbpb) { + public CommonBorderPaddingBackground fetch(CommonBorderPaddingBackground cbpb) { return (CommonBorderPaddingBackground) fetch((Object) cbpb); } /** - * Checks if the given {@link CommonBorderPaddingBackground.BorderInfo} is present in the cache - - * if so, returns a reference to the cached instance. + * Checks if the given {@link CommonBorderPaddingBackground.BorderInfo} is present + * in the cache - if so, returns a reference to the cached instance. * Otherwise the given object is added to the cache and returned. * * @param bi the BorderInfo instance to check for * @return the cached instance */ - public final CommonBorderPaddingBackground.BorderInfo fetch(CommonBorderPaddingBackground.BorderInfo bi) { - + public CommonBorderPaddingBackground.BorderInfo fetch( + CommonBorderPaddingBackground.BorderInfo bi) { return (CommonBorderPaddingBackground.BorderInfo) fetch((Object) bi); } diff --git a/src/java/org/apache/fop/svg/PDFGraphics2D.java b/src/java/org/apache/fop/svg/PDFGraphics2D.java index ca2245a12..cd0a4133b 100644 --- a/src/java/org/apache/fop/svg/PDFGraphics2D.java +++ b/src/java/org/apache/fop/svg/PDFGraphics2D.java @@ -285,7 +285,7 @@ public class PDFGraphics2D extends AbstractGraphics2D { /** * Get the string containing all the commands written into this - * Grpahics. + * Graphics. * @return the string containing the PDF markup */ public String getString() { @@ -294,7 +294,7 @@ public class PDFGraphics2D extends AbstractGraphics2D { /** * Get the string buffer from the currentStream, containing all - * the commands written into this Grpahics so far. + * the commands written into this Graphics so far. * @return the StringBuffer containing the PDF markup */ public StringBuffer getBuffer() { @@ -872,7 +872,7 @@ public class PDFGraphics2D extends AbstractGraphics2D { if (paint instanceof RadialGradientPaint) { RadialGradientPaint rgp = (RadialGradientPaint)paint; - // There is essentially no way to support repeate + // There is essentially no way to support repeats // in PDF for radial gradients (the one option would // be to 'grow' the outer circle until it fully covered // the bounds and then grow the stops accordingly, the diff --git a/src/java/org/apache/fop/svg/PDFTextPainter.java b/src/java/org/apache/fop/svg/PDFTextPainter.java index d8123c4fb..06fea54cc 100644 --- a/src/java/org/apache/fop/svg/PDFTextPainter.java +++ b/src/java/org/apache/fop/svg/PDFTextPainter.java @@ -147,7 +147,9 @@ public class PDFTextPainter extends StrokingTextPainter { textUtil.beginTextObject(); textUtil.setFonts(fonts); - textUtil.setTextRenderingMode(tpi.fillPaint != null, tpi.strokePaint != null, false); + boolean stroke = (tpi.strokePaint != null) + && (tpi.strokeStroke != null); + textUtil.setTextRenderingMode(tpi.fillPaint != null, stroke, false); AffineTransform localTransform = new AffineTransform(); Point2D prevPos = null; diff --git a/src/java/org/apache/fop/util/DataURIResolver.java b/src/java/org/apache/fop/util/DataURIResolver.java index 89db6dc9d..99a8318c8 100644 --- a/src/java/org/apache/fop/util/DataURIResolver.java +++ b/src/java/org/apache/fop/util/DataURIResolver.java @@ -19,60 +19,25 @@ package org.apache.fop.util; -import java.io.ByteArrayInputStream; - import javax.xml.transform.Source; import javax.xml.transform.TransformerException; import javax.xml.transform.URIResolver; -import javax.xml.transform.stream.StreamSource; - -// base64 support for "data" urls -import org.apache.xmlgraphics.util.io.Base64DecodeStream; /** - * Resolves data URLs (described in RFC 2397) returning its data as a StreamSource. - * - * @see javax.xml.transform.URIResolver - * @see RFC 2397 + * @deprecated + * @see org.apache.xmlgraphics.util.uri.DataURIResolver */ public class DataURIResolver implements URIResolver { - /** - * {@inheritDoc} - */ - public Source resolve(String href, String base) throws TransformerException { - if (href.startsWith("data:")) { - return parseDataURI(href); - } else { - return null; - } - } + private final URIResolver newResolver = new org.apache.xmlgraphics.util.uri.DataURIResolver(); /** - * Parses inline data URIs as generated by MS Word's XML export and FO - * stylesheet. - * - * @see RFC 2397 + * @deprecated + * @see org.apache.xmlgraphics.util.uri.DataURIResolver#resolve(String, + * String) */ - private Source parseDataURI(String href) { - int commaPos = href.indexOf(','); - // header is of the form data:[][;base64] - String header = href.substring(0, commaPos); - String data = href.substring(commaPos + 1); - if (header.endsWith(";base64")) { - byte[] bytes = data.getBytes(); - ByteArrayInputStream encodedStream = new ByteArrayInputStream(bytes); - Base64DecodeStream decodedStream = new Base64DecodeStream( - encodedStream); - return new StreamSource(decodedStream); - } else { - // Note that this is not quite the full story here. But since we are - // only interested - // in base64-encoded binary data, the next line will probably never - // be called. - //TODO Handle un-escaping of special URL chars like %20 - return new StreamSource(new java.io.StringReader(data)); - } + public Source resolve(String href, String base) throws TransformerException { + return newResolver.resolve(href, base); } } diff --git a/src/java/org/apache/fop/util/DataURLUtil.java b/src/java/org/apache/fop/util/DataURLUtil.java index d8f7f17bf..8568df274 100644 --- a/src/java/org/apache/fop/util/DataURLUtil.java +++ b/src/java/org/apache/fop/util/DataURLUtil.java @@ -21,47 +21,33 @@ package org.apache.fop.util; import java.io.IOException; import java.io.InputStream; -import java.io.StringWriter; import java.io.Writer; -import org.apache.commons.io.IOUtils; -import org.apache.xmlgraphics.util.io.Base64EncodeStream; - /** - * Utility classes for generating RFC 2397 data URLs. + * @deprecated + * @see org.apache.xmlgraphics.util.uri.DataURLUtil */ public class DataURLUtil { /** - * Creates a new data URL and returns it as a String. - * @param in the InputStream to read the data from - * @param mediatype the MIME type of the content, or null - * @return the newly created data URL - * @throws IOException if an I/O error occurs + * @deprecated + * @see org.apache.xmlgraphics.util.uri.DataURLUtil#createDataURL(InputStream, + * String) */ - public static String createDataURL(InputStream in, String mediatype) throws IOException { - StringWriter writer = new StringWriter(); - writeDataURL(in, mediatype, writer); - return writer.toString(); + public static String createDataURL(InputStream in, String mediatype) + throws IOException { + return org.apache.xmlgraphics.util.uri.DataURLUtil.createDataURL(in, + mediatype); } /** - * Generates a data URL and writes it to a Writer. - * @param in the InputStream to read the data from - * @param mediatype the MIME type of the content, or null - * @param writer the Writer to write to - * @throws IOException if an I/O error occurs + * @deprecated + * @see org.apache.xmlgraphics.util.uri.DataURLUtil#writeDataURL(InputStream, + * String, Writer) */ - public static void writeDataURL(InputStream in, String mediatype, Writer writer) - throws IOException { - writer.write("data:"); - if (mediatype != null) { - writer.write(mediatype); - } - writer.write(";base64,"); - Base64EncodeStream out = new Base64EncodeStream( - new WriterOutputStream(writer, "US-ASCII")); - IOUtils.copy(in, out); - out.flush(); + public static void writeDataURL(InputStream in, String mediatype, + Writer writer) throws IOException { + org.apache.xmlgraphics.util.uri.DataURLUtil.writeDataURL(in, mediatype, + writer); } } diff --git a/src/java/org/apache/fop/util/UnitConv.java b/src/java/org/apache/fop/util/UnitConv.java new file mode 100644 index 000000000..cf599712f --- /dev/null +++ b/src/java/org/apache/fop/util/UnitConv.java @@ -0,0 +1,170 @@ +/* + * 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.util; + +import java.awt.geom.AffineTransform; + +/** + * Utility class for unit conversions. + * @deprecated use org.apache.xmlgraphics.util.UnitConv instead. + */ +public final class UnitConv { + + /** + * conversion factory from millimeters to inches. + * @deprecated use org.apache.xmlgraphics.util.UnitConv.IN2MM instead. + */ + public static final float IN2MM = org.apache.xmlgraphics.util.UnitConv.IN2MM; + + /** + * conversion factory from centimeters to inches. + * @deprecated use org.apache.xmlgraphics.util.UnitConv.IN2CM instead. + */ + public static final float IN2CM = org.apache.xmlgraphics.util.UnitConv.IN2CM; + + /** + * conversion factory from inches to points. + * @deprecated use org.apache.xmlgraphics.util.UnitConv.IN2PT instead. + */ + public static final int IN2PT = org.apache.xmlgraphics.util.UnitConv.IN2PT; + + /** + * Converts millimeters (mm) to points (pt) + * @param mm the value in mm + * @return the value in pt + * @deprecated use org.apache.xmlgraphics.util.UnitConv.mm2pt(mm) instead. + */ + public static double mm2pt(double mm) { + return org.apache.xmlgraphics.util.UnitConv.mm2pt(mm); + } + + /** + * Converts millimeters (mm) to millipoints (mpt) + * @param mm the value in mm + * @return the value in mpt + * @deprecated use org.apache.xmlgraphics.util.UnitConv.mm2mpt(mm) instead. + */ + public static double mm2mpt(double mm) { + return org.apache.xmlgraphics.util.UnitConv.mm2mpt(mm); + } + + /** + * Converts points (pt) to millimeters (mm) + * @param pt the value in pt + * @return the value in mm + * @deprecated use org.apache.xmlgraphics.util.UnitConv.pt2mm(pt) instead. + */ + public static double pt2mm(double pt) { + return org.apache.xmlgraphics.util.UnitConv.pt2mm(pt); + } + + /** + * Converts millimeters (mm) to inches (in) + * @param mm the value in mm + * @return the value in inches + * @deprecated use org.apache.xmlgraphics.util.UnitConv.pt2mm(pt) instead. + */ + public static double mm2in(double mm) { + return org.apache.xmlgraphics.util.UnitConv.mm2in(mm); + } + + /** + * Converts inches (in) to millimeters (mm) + * @param in the value in inches + * @return the value in mm + * @deprecated use org.apache.xmlgraphics.util.UnitConv.in2mm(in) instead. + */ + public static double in2mm(double in) { + return org.apache.xmlgraphics.util.UnitConv.in2mm(in); + } + + /** + * Converts inches (in) to millipoints (mpt) + * @param in the value in inches + * @return the value in mpt + * @deprecated use org.apache.xmlgraphics.util.UnitConv.in2mpt(in) instead. + */ + public static double in2mpt(double in) { + return org.apache.xmlgraphics.util.UnitConv.in2mpt(in); + } + + /** + * Converts inches (in) to points (pt) + * @param in the value in inches + * @return the value in pt + * @deprecated use org.apache.xmlgraphics.util.UnitConv.in2pt(in) instead. + */ + public static double in2pt(double in) { + return org.apache.xmlgraphics.util.UnitConv.in2pt(in); + } + + /** + * Converts millipoints (mpt) to inches (in) + * @param mpt the value in mpt + * @return the value in inches + * @deprecated use org.apache.xmlgraphics.util.UnitConv.mpt2in(mpt) instead. + */ + public static double mpt2in(double mpt) { + return org.apache.xmlgraphics.util.UnitConv.mpt2in(mpt); + } + + /** + * Converts millimeters (mm) to pixels (px) + * @param mm the value in mm + * @param resolution the resolution in dpi (dots per inch) + * @return the value in pixels + * @deprecated use org.apache.xmlgraphics.util.UnitConv.mm2px(mm, resolution) instead. + */ + public static double mm2px(double mm, int resolution) { + return org.apache.xmlgraphics.util.UnitConv.mm2px(mm, resolution); + } + + /** + * Converts millipoints (mpt) to pixels (px) + * @param mpt the value in mpt + * @param resolution the resolution in dpi (dots per inch) + * @return the value in pixels + * @deprecated use org.apache.xmlgraphics.util.UnitConv.mpt2px(mpt, resolution) instead. + */ + public static double mpt2px(double mpt, int resolution) { + return org.apache.xmlgraphics.util.UnitConv.mpt2px(mpt, resolution); + } + + /** + * Converts a millipoint-based transformation matrix to points. + * @param at a millipoint-based transformation matrix + * @return a point-based transformation matrix + * @deprecated use org.apache.xmlgraphics.util.UnitConv.mptToPt(at) instead. + */ + public static AffineTransform mptToPt(AffineTransform at) { + return org.apache.xmlgraphics.util.UnitConv.mptToPt(at); + } + + /** + * Converts a point-based transformation matrix to millipoints. + * @param at a point-based transformation matrix + * @return a millipoint-based transformation matrix + * @deprecated use org.apache.xmlgraphics.util.UnitConv.ptToMpt(at) instead. + */ + public static AffineTransform ptToMpt(AffineTransform at) { + return org.apache.xmlgraphics.util.UnitConv.ptToMpt(at); + } + +} diff --git a/src/java/org/apache/fop/util/WriterOutputStream.java b/src/java/org/apache/fop/util/WriterOutputStream.java index fb6875498..e08109ab0 100644 --- a/src/java/org/apache/fop/util/WriterOutputStream.java +++ b/src/java/org/apache/fop/util/WriterOutputStream.java @@ -24,68 +24,72 @@ import java.io.OutputStream; import java.io.Writer; /** - * An OutputStream wrapper for a Writer. + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream */ public class WriterOutputStream extends OutputStream { - private Writer writer; - private String encoding; + private final org.apache.xmlgraphics.util.WriterOutputStream writerOutputStream; /** - * Creates a new WriterOutputStream. - * @param writer the Writer to write to + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream#WriterOutputStream(Writer) + * String) */ public WriterOutputStream(Writer writer) { - this(writer, null); + writerOutputStream = new org.apache.xmlgraphics.util.WriterOutputStream( + writer); } /** - * Creates a new WriterOutputStream. - * @param writer the Writer to write to - * @param encoding the encoding to use, or null if the default encoding should be used + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream#WriterOutputStream(Writer, + * String) String) */ public WriterOutputStream(Writer writer, String encoding) { - this.writer = writer; - this.encoding = encoding; + writerOutputStream = new org.apache.xmlgraphics.util.WriterOutputStream( + writer, encoding); } /** - * {@inheritDoc} + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream#close() */ public void close() throws IOException { - writer.close(); + writerOutputStream.close(); } /** - * {@inheritDoc} + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream#flush() */ public void flush() throws IOException { - writer.flush(); + writerOutputStream.flush(); } /** - * {@inheritDoc} + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream#write(byte[], int, + * int) */ public void write(byte[] buf, int offset, int length) throws IOException { - if (encoding != null) { - writer.write(new String(buf, offset, length, encoding)); - } else { - writer.write(new String(buf, offset, length)); - } + writerOutputStream.write(buf, offset, length); } /** - * {@inheritDoc} + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream#write(byte[]) */ public void write(byte[] buf) throws IOException { - write(buf, 0, buf.length); + writerOutputStream.write(buf); } /** - * {@inheritDoc} + * @deprecated + * @see org.apache.xmlgraphics.util.WriterOutputStream#write(int) */ public void write(int b) throws IOException { - write(new byte[] {(byte)b}); + writerOutputStream.write(b); } } diff --git a/status.xml b/status.xml index 1cde45913..02edefb4e 100644 --- a/status.xml +++ b/status.xml @@ -53,6 +53,12 @@ + + Fixed memory leak in property cache (not cleaning stale PropertyCache$CacheEntry instances). + + + Fixed text stroking in SVG when the stroke-width is zero. + Fixed the source for a division by zero when the content of an fo:leader with leader-pattern="use-content" collapses to zero width during layout. @@ -135,7 +141,7 @@ Fixed a ClassCastException when using an fo:wrapper as a child of an fo:block-container. - + Add support for font substitution. @@ -158,7 +164,7 @@ Add partial support for the "show-destination" property on fo:basic-link (PDF output only; see limitations on the compliance page) - + Added minimal support for integer keep values on the various keep properties on block-level FOs. For now, all integer values are treated the same (i.e. without strength distinction). Using integers allows to avoid overflows that can happen when "always" is used extensively. @@ -186,7 +192,7 @@ When a JPEG image is embedded, an optionally embedded color profile is filtered out as it's already embedded separately in the PDF file. - + Added support for addressing all glyphs available in a Type 1 font, not just the ones in the font's primary encoding. @@ -685,7 +691,7 @@ AFP Renderer: Bugfix for 1 bit images where the width is not a multiple of 8. - + Support for keep-together.within-line="always". diff --git a/test/java/org/apache/fop/UtilityCodeTestSuite.java b/test/java/org/apache/fop/UtilityCodeTestSuite.java index 6611f532e..a073c4988 100644 --- a/test/java/org/apache/fop/UtilityCodeTestSuite.java +++ b/test/java/org/apache/fop/UtilityCodeTestSuite.java @@ -26,7 +26,6 @@ import org.apache.fop.events.BasicEventTestCase; import org.apache.fop.pdf.PDFObjectTestCase; import org.apache.fop.traits.BorderPropsTestCase; import org.apache.fop.util.ColorUtilTestCase; -import org.apache.fop.util.DataURIResolverTestCase; import org.apache.fop.util.ElementListUtilsTestCase; import org.apache.fop.util.PDFNumberTestCase; import org.apache.fop.util.XMLResourceBundleTestCase; @@ -49,7 +48,6 @@ public class UtilityCodeTestSuite { suite.addTest(new TestSuite(ColorUtilTestCase.class)); suite.addTest(new TestSuite(BorderPropsTestCase.class)); suite.addTest(new TestSuite(ElementListUtilsTestCase.class)); - suite.addTest(new TestSuite(DataURIResolverTestCase.class)); suite.addTest(new TestSuite(BasicEventTestCase.class)); suite.addTest(new TestSuite(XMLResourceBundleTestCase.class)); //$JUnit-END$ diff --git a/test/java/org/apache/fop/memory/MemoryEater.java b/test/java/org/apache/fop/memory/MemoryEater.java index bdbd47897..a665580ae 100644 --- a/test/java/org/apache/fop/memory/MemoryEater.java +++ b/test/java/org/apache/fop/memory/MemoryEater.java @@ -34,6 +34,7 @@ import javax.xml.transform.sax.SAXResult; import javax.xml.transform.sax.SAXTransformerFactory; import javax.xml.transform.stream.StreamSource; +import org.apache.commons.io.IOUtils; import org.apache.commons.io.output.NullOutputStream; import org.apache.fop.apps.FOUserAgent; @@ -51,28 +52,48 @@ public class MemoryEater { private FopFactory fopFactory = FopFactory.newInstance(); private Templates replicatorTemplates; + private Stats stats; + public MemoryEater() throws TransformerConfigurationException, MalformedURLException { File xsltFile = new File("test/xsl/fo-replicator.xsl"); Source xslt = new StreamSource(xsltFile); replicatorTemplates = tFactory.newTemplates(xslt); } - private void eatMemory(File foFile, int replicatorRepeats) throws Exception { + private void eatMemory(File foFile, int runRepeats, int replicatorRepeats) throws Exception { + stats = new Stats(); + for (int i = 0; i < runRepeats; i++) { + eatMemory(i, foFile, replicatorRepeats); + stats.progress(i, runRepeats); + } + stats.dumpFinalStats(); + System.out.println(stats.getGoogleChartURL()); + } + + private void eatMemory(int callIndex, File foFile, int replicatorRepeats) throws Exception { Source src = new StreamSource(foFile); Transformer transformer = replicatorTemplates.newTransformer(); transformer.setParameter("repeats", new Integer(replicatorRepeats)); OutputStream out = new NullOutputStream(); //write to /dev/nul - FOUserAgent userAgent = fopFactory.newFOUserAgent(); - userAgent.setBaseURL(foFile.getParentFile().toURL().toExternalForm()); - Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent, out); - Result res = new SAXResult(fop.getDefaultHandler()); - - transformer.transform(src, res); + try { + FOUserAgent userAgent = fopFactory.newFOUserAgent(); + userAgent.setBaseURL(foFile.getParentFile().toURL().toExternalForm()); + Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent, out); + Result res = new SAXResult(fop.getDefaultHandler()); - System.out.println("Generated " + fop.getResults().getPageCount() + " pages."); + transformer.transform(src, res); + stats.notifyPagesProduced(fop.getResults().getPageCount()); + if (callIndex == 0) { + System.out.println(foFile.getName() + " generates " + + fop.getResults().getPageCount() + " pages."); + } + stats.checkStats(); + } finally { + IOUtils.closeQuietly(out); + } } private static void prompt() throws IOException { @@ -108,9 +129,7 @@ public class MemoryEater { long start = System.currentTimeMillis(); MemoryEater app = new MemoryEater(); - for (int i = 0; i < runRepeats; i++) { - app.eatMemory(testFile, replicatorRepeats); - } + app.eatMemory(testFile, runRepeats, replicatorRepeats); long duration = System.currentTimeMillis() - start; System.out.println("Success! Job took " + duration + " ms"); diff --git a/test/java/org/apache/fop/memory/Stats.java b/test/java/org/apache/fop/memory/Stats.java new file mode 100644 index 000000000..9e371251d --- /dev/null +++ b/test/java/org/apache/fop/memory/Stats.java @@ -0,0 +1,121 @@ +/* + * 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.memory; + +import java.util.Iterator; +import java.util.List; + +class Stats { + + private static final int INTERVAL = 2000; + + private long startTime = System.currentTimeMillis(); + private long lastProgressDump = startTime; + private int pagesProduced; + + private int totalPagesProduced; + + private int step; + private int stepCount; + + private List samples = new java.util.LinkedList(); + + public void checkStats() { + long now = System.currentTimeMillis(); + if (now > lastProgressDump + INTERVAL) { + dumpStats(); + reset(); + } + } + + public void notifyPagesProduced(int count) { + pagesProduced += count; + totalPagesProduced += count; + } + + public void reset() { + pagesProduced = 0; + lastProgressDump = System.currentTimeMillis(); + } + + public void dumpStats() { + long duration = System.currentTimeMillis() - lastProgressDump; + + if (stepCount != 0) { + int progress = 100 * step / stepCount; + System.out.println("Progress: " + progress + "%, " + (stepCount - step) + " left"); + } + + long ppm = 60000 * pagesProduced / duration; + System.out.println("Speed: " + ppm + "ppm"); + samples.add(new Sample((int)ppm)); + } + + public void dumpFinalStats() { + long duration = System.currentTimeMillis() - startTime; + System.out.println("Final statistics"); + System.out.println("Pages produced: " +totalPagesProduced); + long ppm = 60000 * totalPagesProduced / duration; + System.out.println("Average speed: " + ppm + "ppm"); + } + + public String getGoogleChartURL() { + StringBuffer sb = new StringBuffer("http://chart.apis.google.com/chart?"); + //http://chart.apis.google.com/chart?cht=ls&chd=t:60,40&chs=250x100&chl=Hello|World + sb.append("cht=ls"); + sb.append("&chd=t:"); + boolean first = true; + int maxY = 0; + Iterator iter = samples.iterator(); + while (iter.hasNext()) { + Sample sample = (Sample)iter.next(); + if (first) { + first = false; + } else { + sb.append(','); + } + sb.append(sample.ppm); + maxY = Math.max(maxY, sample.ppm); + } + int ceilY = ((maxY / 1000) + 1) * 1000; + sb.append("&chs=1000x300"); //image size + sb.append("&chds=0,").append(ceilY); //data scale + sb.append("&chg=0,20"); //scale steps + sb.append("&chxt=y"); + sb.append("&chxl=0:|0|" + ceilY); + return sb.toString(); + } + + private static class Sample { + + private int ppm; + + public Sample(int ppm) { + this.ppm = ppm; + } + } + + public void progress(int step, int stepCount) { + this.step = step; + this.stepCount = stepCount; + + } + +} diff --git a/test/java/org/apache/fop/util/DataURIResolverTestCase.java b/test/java/org/apache/fop/util/DataURIResolverTestCase.java deleted file mode 100644 index 631b8dac1..000000000 --- a/test/java/org/apache/fop/util/DataURIResolverTestCase.java +++ /dev/null @@ -1,116 +0,0 @@ -/* - * 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.util; - -import java.io.ByteArrayInputStream; - -import javax.xml.transform.Source; -import javax.xml.transform.URIResolver; -import javax.xml.transform.stream.StreamSource; - -import org.apache.commons.io.IOUtils; - -import junit.framework.TestCase; - -/** - * Test case for the RFC 2397 data URL/URI resolver. - */ -public class DataURIResolverTestCase extends TestCase { - - private static final byte[] TESTDATA = new byte[] {0, 1, 2, 3, 4, 5}; - - /** - * Tests DataURLUtil. - * @throws Exception if an error occurs - */ - public void testRFC2397Generator() throws Exception { - String url = DataURLUtil.createDataURL(new ByteArrayInputStream(TESTDATA), null); - assertEquals("Generated data URL is wrong", "data:;base64,AAECAwQF", url); - - url = DataURLUtil.createDataURL(new ByteArrayInputStream(TESTDATA), "application/pdf"); - assertEquals("Generated data URL is wrong", "data:application/pdf;base64,AAECAwQF", url); - } - - /** - * Test the URIResolver contract if the protocol doesn't match. Resolver must return null - * in this case. - * @throws Exception if an error occurs - */ - public void testNonMatchingContract() throws Exception { - URIResolver resolver = new DataURIResolver(); - Source src; - - src = resolver.resolve("http://xmlgraphics.apache.org/fop/index.html", null); - assertNull(src); - - src = resolver.resolve("index.html", "http://xmlgraphics.apache.org/fop/"); - assertNull(src); - } - - private static boolean byteCmp(byte[] src, int srcOffset, byte[] cmp) { - for (int i = 0, c = cmp.length; i < c; i++) { - if (src[srcOffset + i] != cmp[i]) { - return false; - } - } - return true; - } - - /** - * Test the DataURIResolver with correct values. - * @throws Exception if an error occurs - */ - public void testDataURLHandling() throws Exception { - URIResolver resolver = new DataURIResolver(); - Source src; - - src = resolver.resolve("data:;base64,AAECAwQF", null); - assertNotNull(src); - StreamSource streamSource = (StreamSource)src; - byte[] data = IOUtils.toByteArray(streamSource.getInputStream()); - assertTrue("Decoded data doesn't match the test data", byteCmp(TESTDATA, 0, data)); - - src = resolver.resolve( - "data:application/octet-stream;interpreter=fop;base64,AAECAwQF", null); - assertNotNull(src); - streamSource = (StreamSource)src; - assertNotNull(streamSource.getInputStream()); - assertNull(streamSource.getReader()); - data = IOUtils.toByteArray(streamSource.getInputStream()); - assertTrue("Decoded data doesn't match the test data", byteCmp(TESTDATA, 0, data)); - - src = resolver.resolve("data:,FOP", null); - assertNotNull(src); - streamSource = (StreamSource)src; - assertNull(streamSource.getInputStream()); - assertNotNull(streamSource.getReader()); - String text = IOUtils.toString(streamSource.getReader()); - assertEquals("FOP", text); - - /* TODO Un-escaping of special URL chars like %20 hasn't been implemented, yet. - src = resolver.resolve("data:,A%20brief%20note", null); - assertNotNull(src); - streamSource = (StreamSource)src; - text = IOUtils.toString(streamSource.getReader()); - assertEquals("A brief note", text); - */ - } - -}