Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOXIA-409] Upgrade to FOP 2.2 #7

Merged
merged 1 commit into from
Feb 7, 2018
Merged

[DOXIA-409] Upgrade to FOP 2.2 #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doxia-modules/doxia-module-fo/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ under the License.
<dependency>
<groupId>org.apache.xmlgraphics</groupId>
<artifactId>fop</artifactId>
<version>0.95</version>
<version>2.2</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
Expand Down
58 changes: 15 additions & 43 deletions doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URI;
import java.util.Date;

import javax.xml.transform.Result;
Expand All @@ -38,6 +39,7 @@
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.apps.Fop;
import org.apache.fop.apps.FopFactory;
import org.apache.fop.apps.FopFactoryBuilder;
import org.apache.fop.apps.MimeConstants;
import org.apache.maven.doxia.document.DocumentModel;
import org.codehaus.plexus.util.IOUtil;
Expand All @@ -52,28 +54,11 @@
*/
public class FoUtils
{
/** To reuse the FopFactory **/
private static final FopFactory FOP_FACTORY = FopFactory.newInstance();

/** To reuse the TransformerFactory **/
private static final TransformerFactory TRANSFORMER_FACTORY = TransformerFactory.newInstance();

/**
* Converts an FO file to a PDF file using FOP.
*
* @param fo the FO file, not null.
* @param pdf the target PDF file, not null.
* @param resourceDir The base directory for relative path resolution, could be null.
* If null, defaults to the parent directory of fo.
* @param documentModel the document model to add PDF metadatas like author, title and keywords, could be null.
* @throws javax.xml.transform.TransformerException In case of a conversion problem.
* @since 1.1.1
*/
public static void convertFO2PDF( File fo, File pdf, String resourceDir, DocumentModel documentModel )
throws TransformerException
{
FOUserAgent foUserAgent = getDefaultUserAgent( fo, resourceDir );

private static void prepareUserAgent( FOUserAgent foUserAgent, DocumentModel documentModel ) {
if ( documentModel != null && documentModel.getMeta() != null )
{
// http://xmlgraphics.apache.org/fop/embedding.html#user-agent
Expand Down Expand Up @@ -113,8 +98,6 @@ public static void convertFO2PDF( File fo, File pdf, String resourceDir, Documen
{
foUserAgent.setCreationDate( new Date() );
}

convertFO2PDF( fo, pdf, resourceDir, foUserAgent );
}

/**
Expand All @@ -124,16 +107,13 @@ public static void convertFO2PDF( File fo, File pdf, String resourceDir, Documen
* @param pdf the target PDF file, not null.
* @param resourceDir The base directory for relative path resolution, could be null.
* If null, defaults to the parent directory of fo.
* @param foUserAgent the FOUserAgent to use.
* May be null, in which case a default user agent will be used.
* @param documentModel the document model to add PDF metadatas like author, title and keywords, could be null.
* @throws javax.xml.transform.TransformerException In case of a conversion problem.
* @since 1.1.1
*/
public static void convertFO2PDF( File fo, File pdf, String resourceDir, FOUserAgent foUserAgent )
public static void convertFO2PDF( File fo, File pdf, String resourceDir, DocumentModel documentModel )
throws TransformerException
{
FOUserAgent userAgent = ( foUserAgent == null ? getDefaultUserAgent( fo, resourceDir ) : foUserAgent );

OutputStream out = null;
try
{
Expand All @@ -149,7 +129,11 @@ public static void convertFO2PDF( File fo, File pdf, String resourceDir, FOUserA
Result res = null;
try
{
Fop fop = FOP_FACTORY.newFop( MimeConstants.MIME_PDF, userAgent, out );
URI baseURI = getBaseURI( fo, resourceDir );
FopFactory fopFactory = new FopFactoryBuilder( baseURI ).build();
FOUserAgent userAgent = fopFactory.newFOUserAgent();
prepareUserAgent( userAgent, documentModel );
Fop fop = fopFactory.newFop( MimeConstants.MIME_PDF, userAgent, out );
res = new SAXResult( fop.getDefaultHandler() );
}
catch ( FOPException e )
Expand Down Expand Up @@ -193,34 +177,22 @@ public static void convertFO2PDF( File fo, File pdf, String resourceDir )
}

/**
* Returns a base URL to be used by the FOUserAgent.
* Returns a base URI.
*
* @param fo the FO file.
* @param resourceDir the resource directory.
* @return String.
* @return URI.
*/
private static String getBaseURL( File fo, String resourceDir )
private static URI getBaseURI( File fo, String resourceDir )
{
String url = null;

if ( resourceDir == null )
{
url = "file:///" + fo.getParent() + "/";
return fo.getParentFile().toURI();
}
else
{
url = "file:///" + resourceDir + "/";
return new File( resourceDir + "/" ).toURI();
}

return url;
}

private static FOUserAgent getDefaultUserAgent( File fo, String resourceDir )
{
FOUserAgent foUserAgent = FOP_FACTORY.newFOUserAgent();
foUserAgent.setBaseURL( getBaseURL( fo, resourceDir ) );

return foUserAgent;
}

private FoUtils()
Expand Down