We keep this here in order to reset the context classloader * in execute. We can't use liaison.getClass().getClassLoader() * since the actual liaison class may have been loaded by a loader * higher up (system classloader, for example).
* * @since Ant 1.6.2 */ private AntClassLoader loader = null; /** * Mapper to use when a set of files gets processed. * * @since Ant 1.6.2 */ private Mapper mapperElement = null; /** * Additional resource collections to process. * * @since Ant 1.7 */ private Union resources = new Union(); /** * Whether to use the implicit fileset. * * @since Ant 1.7 */ private boolean useImplicitFileset = true; /** * The XSLT transformer */ private Controller transformer = null; /** * Whether schema validation is strict, lax, or skip */ private String schemaValidation = "skip"; /** * Whether DTD validation is on or off. Default is off. */ private boolean dtdValidation = false; /** * Whether attribute defaults should be expanded */ private boolean expandAttributeDefaults = true; /** * Whether extension functions are permitted or not. Default is true. */ private boolean allowExtensions = true; /** * Initial mode name */ private String initialMode; /** * Initial template name */ private String initialTemplate; /** * Whether lineNumbering of the source document is switched on. Default is off. */ private boolean lineNumbering; /** * Trace stylesheet execution. Default is off. */ private boolean tracing; /** * Policy for handling XSLT recoverable errors: silent|recover|fatal */ private String recoveryPolicy; /** * Whether to use XML 1.0 or XML 1.1 rules for names, etc */ private String xmlVersion = "1.0"; /** * Create a new saxon-xslt Task. */ public AntTransform() { } /** * Set whether to style all files in the included directories as well; * optional, default is true. * * @param b true if files in included directories are processed. * @since Ant 1.5 */ public void setScanIncludedDirectories(boolean b) { performDirectoryScan = b; } /** * Controls whether the stylesheet is reloaded for every transform. * *Setting this to true may get around a bug in certain * Xalan-J versions, default is false.
* @param b aboolean value
* @since Ant 1.5.2
*/
public void setReloadStylesheet(boolean b) {
reuseLoadedStylesheet = !b;
}
/**
* Defines the mapper to map source to destination files.
* @param mapper the mapper to use
* @exception BuildException if more than one mapper is defined
* @since Ant 1.6.2
*/
public void addMapper(Mapper mapper) {
if (mapperElement != null) {
throw new BuildException("Cannot define more than one mapper",
getLocation());
}
mapperElement = mapper;
}
/**
* Adds a collection of resources to style in addition to the
* given file or the implicit fileset.
*
* @param rc the collection of resources to style
* @since Ant 1.7
*/
public void add(ResourceCollection rc) {
resources.add(rc);
}
/**
* Add a nested <style> element.
* @param rc the configured Resources object represented as <style>.
* @since Ant 1.7
*/
public void addConfiguredStyle(Resources rc) {
if (rc.size() != 1) {
throw new BuildException("The style element must be specified"
+ " with exactly one nested resource.");
}
setXslResource((Resource) rc.iterator().next());
}
/**
* API method to set the XSL Resource.
* @param xslResource Resource to set as the stylesheet.
* @since Ant 1.7
*/
public void setXslResource(Resource xslResource) {
this.xslResource = xslResource;
}
/**
* Adds a nested filenamemapper.
* @param fileNameMapper the mapper to add
* @exception BuildException if more than one mapper is defined
* @since Ant 1.7.0
*/
public void add(FileNameMapper fileNameMapper) throws BuildException {
Mapper mapper = new Mapper(getProject());
mapper.add(fileNameMapper);
addMapper(mapper);
}
/**
* Executes the task.
*
* @exception BuildException if there is an execution problem.
*/
public void execute() throws BuildException {
log("AntTransform.execute() schema-aware=" + schemaAware + " version " + Version.getProductVersion());
if (schemaAware) {
// remove this line to compile the code for use under Saxon-B only
config = Configuration.makeSchemaAwareConfiguration(null, null);
config.displayLicenseMessage();
} else {
config = new Configuration();
}
config.setAllowExternalFunctions(allowExtensions);
config.setExpandAttributeDefaults(expandAttributeDefaults);
config.setLineNumbering(lineNumbering);
config.setValidation(dtdValidation);
config.setCompileWithTracing(tracing);
config.setXMLVersion("1.1".equals(xmlVersion) ? Configuration.XML11 : Configuration.XML10);
if ("skip".equals(schemaValidation)) {
config.setSchemaValidationMode(Validation.SKIP);
} else if ("strict".equals(schemaValidation)) {
config.setSchemaValidationMode(Validation.STRICT);
} else if ("lax".equals(schemaValidation)) {
config.setSchemaValidationMode(Validation.LAX);
} else {
throw new BuildException("Validation must be strict or lax or skip");
}
File savedBaseDir = baseDir;
DirectoryScanner scanner;
String[] list;
String[] dirs;
if (xslResource == null && xslFile == null) {
throw new BuildException("specify the "
+ "stylesheet either as a filename in style "
+ "attribute or as a nested resource", getLocation());
}
if (xslResource != null && xslFile != null) {
throw new BuildException("specify the "
+ "stylesheet either as a filename in style "
+ "attribute or as a nested resource but not "
+ "as both", getLocation());
}
if (inFile != null && !inFile.exists()) {
throw new BuildException(
"input file " + inFile.toString() + " does not exist", getLocation());
}
try {
if (baseDir == null) {
baseDir = getProject().resolveFile(".");
}
if (xslFile != null) {
// If we enter here, it means that the stylesheet is supplied
// via style attribute
File stylesheet = getProject().resolveFile(xslFile);
if (!stylesheet.exists()) {
stylesheet = FILE_UTILS.resolveFile(baseDir, xslFile);
/*
* shouldn't throw out deprecation warnings before we know,
* the wrong version has been used.
*/
if (stylesheet.exists()) {
log("DEPRECATED - the 'style' attribute should be relative "
+ "to the project's");
log(" basedir, not the tasks's basedir.");
}
}
FileResource fr = new FileResource();
fr.setProject(getProject());
fr.setFile(stylesheet);
xslResource = fr;
}
// if we have an in file and out then process them
if (inFile != null && outFile != null) {
process(inFile, outFile, xslResource);
return;
}
/*
* if we get here, in and out have not been specified, we are
* in batch processing mode.
*/
//-- make sure destination directory exists...
checkDest();
if (useImplicitFileset) {
scanner = getDirectoryScanner(baseDir);
log("Transforming into " + destDir, Project.MSG_INFO);
// Process all the files marked for styling
list = scanner.getIncludedFiles();
for (int i = 0; i < list.length; ++i) {
process(baseDir, list[i], destDir, xslResource);
}
if (performDirectoryScan) {
// Process all the directories marked for styling
dirs = scanner.getIncludedDirectories();
for (int j = 0; j < dirs.length; ++j) {
list = new File(baseDir, dirs[j]).list();
for (int i = 0; i < list.length; ++i) {
process(baseDir, dirs[j] + File.separator + list[i],
destDir, xslResource);
}
}
}
} else { // only resource collections, there better be some
if (resources.size() == 0) {
throw new BuildException("no resources specified");
}
}
processResources(xslResource);
} finally {
if (loader != null) {
loader.resetThreadContextLoader();
loader.cleanup();
loader = null;
}
stylesheetLoaded = false;
baseDir = savedBaseDir;
}
}
/**
* Set whether to check dependencies, or always generate;
* optional, default is false.
*
* @param force true if always generate.
*/
public void setForce(boolean force) {
this.force = force;
}
/**
* Set the base directory;
* optional, default is the project's basedir.
*
* @param dir the base directory
**/
public void setBasedir(File dir) {
baseDir = dir;
}
/**
* Set the destination directory into which the XSL result
* files should be copied to;
* required, unless in and out are
* specified.
* @param dir the name of the destination directory
**/
public void setDestdir(File dir) {
destDir = dir;
}
/**
* Set the desired file extension to be used for the target;
* optional, default is html.
* @param name the extension to use
**/
public void setExtension(String name) {
targetExtension = name;
}
/**
* Name of the stylesheet to use - given either relative
* to the project's basedir or as an absolute path; required.
*
* @param xslFile the stylesheet to use
*/
public void setStyle(String xslFile) {
this.xslFile = xslFile;
}
/**
* Set the optional classpath to the XSL processor
*
* @param classpath the classpath to use when loading the XSL processor
*/
public void setClasspath(Path classpath) {
createClasspath().append(classpath);
}
/**
* Set the optional classpath to the XSL processor
*
* @return a path instance to be configured by the Ant core.
*/
public Path createClasspath() {
if (classpath == null) {
classpath = new Path(getProject());
}
return classpath.createPath();
}
/**
* Set the reference to an optional classpath to the XSL processor
*
* @param r the id of the Ant path instance to act as the classpath
* for loading the XSL processor
*/
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
/**
* Indicate whether schema-aware processing is required
*
* @param schemaAware true if schema-aware processing is required
*/
public void setSchemaAware(boolean schemaAware) {
//log("setSchemaAware = " + schemaAware);
this.schemaAware = schemaAware;
}
/**
* Indicate whether schema validation for all input files to the transformation is strict, lax, or skip
* @param validation "strict", "lax" or "skip"
*/
public void setSchemaValidation(String validation) {
//log("setValidation = " + validation);
this.schemaValidation = validation;
if (!validation.equals("skip")) {
setSchemaAware(true);
}
}
/**
* Indicate whether DTD validation is on or off
* @param validation set to true to request DTD validation of all input files to the transformation
*/
public void setDTDValidation(boolean validation) {
dtdValidation = validation;
}
/**
* Set whether DTD or schema-defined element and attribute default values should be expanded
* Default is true
* @param expand true to expand default values, false if they are to be suppressed
*/
public void setExpandDefaults(boolean expand) {
expandAttributeDefaults = expand;
}
/**
* Set the initial mode
* @param mode the initial mode for the transformation, in Clark notation
*/
public void setInitialMode(String mode) {
initialMode = mode;
}
/**
* Set the initial template
* @param name the name of the initial template for the transformation, in Clark notation
*/
public void setInitialTemplate(String name) {
initialTemplate = name;
}
/**
* Set the policy for handling recoverable errors
* @param policy one of "silent", "recover", or "fatal". Default is "recover".
*/
public void setRecoveryPolicy(String policy) {
recoveryPolicy = policy;
}
/**
* Set whether to trace stylesheet execution
* @param tracing true to trace execution. Default is false
*/
public void setTracing(boolean tracing) {
this.tracing = tracing;
}
/**
* Set whether to maintain line numbers for input documents
* @param numbering true to maintain line numbers. Default is false
*/
public void setLineNumbering(boolean numbering) {
lineNumbering = numbering;
}
/**
* Set the XML version to be used for validating names
* @param version One of "1.0" or "1.1". Default is "1.0".
*/
public void setXmlVersion(String version) {
xmlVersion = version;
}
/**
* Set whether to use the implicit fileset.
*
* Set this to false if you want explicit control with nested * resource collections.
* @param useimplicitfileset set to true if you want to use implicit fileset * @since Ant 1.7 */ public void setUseImplicitFileset(boolean useimplicitfileset) { useImplicitFileset = useimplicitfileset; } /** * Add the catalog to our internal catalog * * @param xmlCatalog the XMLCatalog instance to use to look up DTDs */ public void addConfiguredXMLCatalog(XMLCatalog xmlCatalog) { this.xmlCatalog.addConfiguredXMLCatalog(xmlCatalog); } /** * Pass the filename of the current processed file as a xsl parameter * to the transformation. This value sets the name of that xsl parameter. * * @param fileNameParameter name of the xsl parameter retrieving the * current file name */ public void setFileNameParameter(String fileNameParameter) { this.fileNameParameter = fileNameParameter; } /** * Pass the directory name of the current processed file as a xsl parameter * to the transformation. This value sets the name of that xsl parameter. * * @param fileDirParameter name of the xsl parameter retrieving the * current file directory */ public void setFileDirParameter(String fileDirParameter) { this.fileDirParameter = fileDirParameter; } /** * Specifies the output name for the styled result from the * in attribute; required if in is set * * @param outFile the output File instance. */ public void setOut(File outFile) { this.outFile = outFile; } /** * specifies a single XML document to be styled. Should be used * with the out attribute; ; required if out is set * * @param inFile the input file */ public void setIn(File inFile) { this.inFile = inFile; } /** * Throws a BuildException if the destination directory hasn't * been specified. * @since Ant 1.7 */ private void checkDest() { if (destDir == null) { String msg = "destdir attributes must be set!"; throw new BuildException(msg); } } /** * Styles all existing resources. * * @since Ant 1.7 */ private void processResources(Resource stylesheet) { Iterator iter = resources.iterator(); while (iter.hasNext()) { Resource r = (Resource) iter.next(); if (!r.isExists()) { continue; } File base = baseDir; String name = r.getName(); if (r instanceof FileResource) { FileResource f = (FileResource) r; base = f.getBaseDir(); if (base == null) { name = f.getFile().getAbsolutePath(); } } process(base, name, destDir, stylesheet); } } /** * Processes the given input XML file and stores the result * in the given resultFile. * * @param baseDir the base directory for resolving files. * @param xmlFile the input file * @param destDir the destination directory * @param stylesheet the stylesheet to use. * @exception BuildException if the processing fails. */ private void process(File baseDir, String xmlFile, File destDir, Resource stylesheet) throws BuildException { File outF = null; File inF; if (fileNameParameter != null) { transformer.setParameter(fileNameParameter, xmlFile); } if (fileDirParameter != null) { transformer.setParameter(fileDirParameter, baseDir.getAbsolutePath()); } try { long styleSheetLastModified = stylesheet.getLastModified(); inF = new File(baseDir, xmlFile); if (inF.isDirectory()) { log("Skipping " + inF + " it is a directory.", Project.MSG_VERBOSE); return; } FileNameMapper mapper; if (mapperElement != null) { mapper = mapperElement.getImplementation(); } else { mapper = new StyleMapper(); } String[] outFileName = mapper.mapFileName(xmlFile); if (outFileName == null || outFileName.length == 0) { log("Skipping " + inFile + " it cannot get mapped to output.", Project.MSG_VERBOSE); return; } else if (outFileName == null || outFileName.length > 1) { log("Skipping " + inFile + " its mapping is ambiguous.", Project.MSG_VERBOSE); return; } outF = new File(destDir, outFileName[0]); if (force || inF.lastModified() > outF.lastModified() || styleSheetLastModified > outF.lastModified()) { ensureDirectoryFor(outF); log("Processing " + inF + " to " + outF); configureLiaison(stylesheet); transform(inF, outF); } } catch (Exception ex) { // If failed to process document, must delete target document, // or it will not attempt to process it the second time log("Failed to process " + inFile, Project.MSG_INFO); if (outF != null) { outF.delete(); } throw new BuildException(ex); } } //-- processXML /** * Process the input file to the output file with the given stylesheet. * * @param inFile the input file to process. * @param outFile the destination file. * @param stylesheet the stylesheet to use. * @exception BuildException if the processing fails. */ private void process(File inFile, File outFile, Resource stylesheet) throws BuildException { try { long styleSheetLastModified = stylesheet.getLastModified(); log("In file " + inFile + " time: " + inFile.lastModified(), Project.MSG_DEBUG); log("Out file " + outFile + " time: " + outFile.lastModified(), Project.MSG_DEBUG); log("Style file " + xslFile + " time: " + styleSheetLastModified, Project.MSG_DEBUG); if (force || inFile.lastModified() >= outFile.lastModified() || styleSheetLastModified >= outFile.lastModified()) { ensureDirectoryFor(outFile); log("Processing " + inFile + " to " + outFile, Project.MSG_INFO); configureLiaison(stylesheet); transform(inFile, outFile); } else { log("Skipping input file " + inFile + " because it is older than output file " + outFile + " and so is the stylesheet " + stylesheet, Project.MSG_DEBUG); } } catch (Exception ex) { log("Failed to process " + inFile, Project.MSG_INFO); if (outFile != null) { outFile.delete(); } throw new BuildException(ex); } } private void transform(File in, File out) { if (transformer == null) { throw new BuildException("No transformer has been created"); } Source ss = new StreamSource(in); Result sr = new StreamResult(out); try { transformer.transform(ss, sr); } catch (TransformerException ex) { log("Failed to transform " + in, Project.MSG_INFO); if (out != null) { out.delete(); } throw new BuildException(ex); } } /** * Ensure the directory exists for a given file * * @param targetFile the file for which the directories are required. * @exception BuildException if the directories cannot be created. */ private void ensureDirectoryFor(File targetFile) throws BuildException { File directory = targetFile.getParentFile(); if (!directory.exists()) { if (!directory.mkdirs()) { throw new BuildException("Unable to create directory: " + directory.getAbsolutePath()); } } } /** * Get the Saxon Configuration being used (useful for subclasses) * @return the Saxon Configuration */ public Configuration getConfiguration() { return config; } /** * Get the XML catalog containing entity definitions * * @return the XML catalog for the task. */ public XMLCatalog getXMLCatalog() { xmlCatalog.setProject(getProject()); return xmlCatalog; } /** * Get an enumeration on the outputproperties. * @return the outputproperties */ public Enumeration getOutputProperties() { return outputProperties.elements(); } /** * Create an instance of an XSL parameter for configuration by Ant. * * @return an instance of the Param class to be configured. */ public Param createParam() { Param p = new Param(); params.addElement(p); return p; } /** * The Param inner class used to store XSL parameters */ public static class Param { /** The parameter name */ private String name = null; /** The parameter's value */ private String expression = null; private String ifProperty; private String unlessProperty; private Project project; /** * Set the current project * * @param project the current project */ public void setProject(Project project) { this.project = project; } /** * Set the parameter name. * * @param name the name of the parameter. */ public void setName(String name) { this.name = name; } /** * The parameter value * NOTE : was intended to be an XSL expression. * @param expression the parameter's value. */ public void setExpression(String expression) { this.expression = expression; } /** * Get the parameter name * * @return the parameter name * @exception BuildException if the name is not set. */ public String getName() throws BuildException { if (name == null) { throw new BuildException("Name attribute is missing."); } return name; } /** * Get the parameter's value * * @return the parameter value * @exception BuildException if the value is not set. */ public String getExpression() throws BuildException { if (expression == null) { throw new BuildException("Expression attribute is missing."); } return expression; } /** * Set whether this param should be used. It will be * used if the property has been set, otherwise it won't. * @param ifProperty name of property */ public void setIf(String ifProperty) { this.ifProperty = ifProperty; } /** * Set whether this param should NOT be used. It * will not be used if the property has been set, otherwise it * will be used. * @param unlessProperty name of property */ public void setUnless(String unlessProperty) { this.unlessProperty = unlessProperty; } /** * Ensures that the param passes the conditions placed * on it withif and unless properties.
* @return true if the task passes the "if" and "unless" parameters
*/
public boolean shouldUse() {
if (ifProperty != null && project.getProperty(ifProperty) == null) {
return false;
} else if (unlessProperty != null
&& project.getProperty(unlessProperty) != null) {
return false;
}
return true;
}
} // Param
/**
* Create an instance of an output property to be configured.
* @return the newly created output property.
* @since Ant 1.5
*/
public OutputProperty createOutputProperty() {
OutputProperty p = new OutputProperty();
outputProperties.addElement(p);
return p;
}
/**
* Specify how the result tree should be output as specified
* in the Serialization specification.
* @since Ant 1.5
*/
public static class OutputProperty {
/** output property name */
private String name;
/** output property value */
private String value;
/**
* @return the output property name.
*/
public String getName() {
return name;
}
/**
* set the name for this property
* @param name A non-null String that specifies an
* output property name, which may be namespace qualified.
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the output property value.
*/
public String getValue() {
return value;
}
/**
* set the value for this property
* @param value The non-null string value of the output property.
*/
public void setValue(String value) {
this.value = value;
}
}
/**
* Initialize internal instance of XMLCatalog
* @throws BuildException on error
*/
public void init() throws BuildException {
super.init();
xmlCatalog.setProject(getProject());
}
/**
* Loads the stylesheet and set xsl:param parameters.
*
* @param stylesheet the file from which to load the stylesheet.
* @exception BuildException if the stylesheet cannot be loaded.
* @deprecated since Ant 1.7
*/
protected void configureLiaison(File stylesheet) throws BuildException {
FileResource fr = new FileResource();
fr.setProject(getProject());
fr.setFile(stylesheet);
configureLiaison(fr);
}
/**
* Loads the stylesheet and set xsl:param parameters.
*
* @param stylesheet the resource from which to load the stylesheet.
* @exception BuildException if the stylesheet cannot be loaded.
* @since Ant 1.7
*/
protected void configureLiaison(Resource stylesheet) throws BuildException {
if (stylesheetLoaded && reuseLoadedStylesheet) {
return;
}
stylesheetLoaded = true;
try {
log("Loading stylesheet " + stylesheet, Project.MSG_INFO);
// We call liason.configure() and then liaison.setStylesheet()
// so that the internal variables of liaison can be set up
if (stylesheet instanceof FileResource) {
File styleFile = ((FileResource) stylesheet).getFile();
CompilerInfo info = new CompilerInfo();
info.setURIResolver(config.getURIResolver());
info.setErrorListener(config.getErrorListener());
info.setCompileWithTracing(config.isCompileWithTracing());
PreparedStylesheet pss = PreparedStylesheet.compile(new StreamSource(styleFile), config, info);
transformer = (Controller)pss.newTransformer();
transformer.setInitialMode(initialMode);
transformer.setInitialTemplate(initialTemplate);
if (tracing) {
transformer.addTraceListener(new XSLTTraceListener());
}
if (recoveryPolicy != null) {
if (recoveryPolicy.equals("silent")) {
transformer.setRecoveryPolicy(Configuration.RECOVER_SILENTLY);
} else if (recoveryPolicy.equals("recover")) {
transformer.setRecoveryPolicy(Configuration.RECOVER_WITH_WARNINGS);
} else {
transformer.setRecoveryPolicy(Configuration.DO_NOT_RECOVER);
}
}
} else {
throw new BuildException("Saxon accepts the stylesheet only as a file",
getLocation());
}
for (Enumeration e = params.elements(); e.hasMoreElements();) {
Param p = (Param) e.nextElement();
if (p.shouldUse()) {
transformer.setParameter(p.getName(), p.getExpression());
}
}
} catch (Exception ex) {
log("Failed to transform using stylesheet " + stylesheet,
Project.MSG_INFO);
throw new BuildException(ex);
}
}
/**
* Mapper implementation of the "traditional" way <xslt>
* mapped filenames.
*
* If the file has an extension, chop it off. Append whatever * the user has specified as extension or ".html".
* * @since Ant 1.6.2 */ private class StyleMapper implements FileNameMapper { public void setFrom(String from) { } public void setTo(String to) { } public String[] mapFileName(String xmlFile) { int dotPos = xmlFile.lastIndexOf('.'); if (dotPos > 0) { xmlFile = xmlFile.substring(0, dotPos); } return new String[] {xmlFile + targetExtension}; } } } // The NOTICE file referred to in the Apache license is reproduced below: //========================================================================= //== NOTICE file corresponding to the section 4 d of == //== the Apache License, Version 2.0, == //== in this case for the Apache Ant distribution. == //========================================================================= // //Apache Ant //Copyright 1999-2006 The Apache Software Foundation // //This product includes software developed by //The Apache Software Foundation (http://www.apache.org/). // //This product includes also software developed by : // - the W3C consortium (http://www.w3c.org) , // - the SAX project (http://www.saxproject.org) // //The