ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ivan Mikushin" <i...@vismech.ru>
Subject Proposal for a new task <xslt> (different semantics than <style>)
Date Sat, 27 Jan 2001 04:51:35 GMT
/*
I encountered a need for a new task which I named <xslt> for a number of
good reasons:
 - one may need to specify XSLT transforms not bound to basedir for the
<style> task instances
 - one may need to supply parameters to an XSL transform
 - <style> has a redundant attribute 'processor' which is unneeded when TrAX
interfaces (seems to become standard) are used
 - XSLT transforms are not necessarily used for styling: you may use it to
generate code, and whatever, so it's reasonable to name the task <xslt> and
to indicate XSLT file with 'transform' attribute.

I rewrote XSLTProcess class (mine is named XSLTProcess2) to meet these
issues (actually took XSLTProcess and changed it a little).

<xslt> task supports inner elements <env> just like <exec> task, doesn't
support 'processor' attribute, and you specify XSLT transform with
'transform' attribute.

I also added a new line to my
org/apache/tools/ant/taskdefs/default.properties file:

xslt=org.apache.tools.ant.taskdefs.XSLTProcess2
*/

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.tools.ant.taskdefs;

import org.apache.tools.ant.*;

import java.io.File;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.StringTokenizer;
import java.util.Vector;
import javax.xml.transform.Templates;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.Transformer;
import javax.xml.transform.stream.StreamSource;
import javax.xml.transform.stream.StreamResult;
import org.apache.tools.ant.types.Environment;

/**
 * A Task to process via XSLT a set of XML documents. This is
 * useful for building views of XML based documentation.
 * arguments:
 * <ul>
 * <li>basedir
 * <li>destdir
 * <li>style
 * <li>includes
 * <li>excludes
 * </ul>
 * Of these arguments, the <b>sourcedir</b> and <b>destdir</b> are
required.
 * <p>
 * This task will recursively scan the sourcedir and destdir
 * looking for XML documents to process via XSLT. Any other files,
 * such as images, or html files in the source directory will be
 * copied into the destination directory.
 *
 * @author <a href="mailto:kvisco@exoffice.com">Keith Visco</a>
 * @author <a href="mailto:rubys@us.ibm.com">Sam Ruby</a>
 * @author <a href="mailto:russgold@acm.org">Russell Gold</a>
 * @author <a href="mailto:ivan@vismech.ru">Ivan Mikushin</a>
 * @version $Revision: 1.8.1 $ $Date: 2001/01/18 09:34:03 $
 */
public class XSLTProcess2 extends MatchingTask {

 private File destDir = null;

 private File baseDir = null;

 private File transformFile = null;

 private String targetExtension = ".html";

 private Transformer transformer = null;

 private Environment env = new Environment();

 /**
  * Creates a new XSLTProcess Task.
 **/
 public XSLTProcess2() {
 } //  XSLTProcess2

 /**
  * Executes the task.
  */
 public void execute() throws BuildException {

  DirectoryScanner scanner;
  String[]         list;
  String[]         dirs;

  if (baseDir == null)
   baseDir = project.resolveFile(".");
   //  make sure Source directory exists...
  if (destDir == null ) {
   String msg = "destdir attributes must be set!";
   throw new BuildException(msg);
  }
  scanner = getDirectoryScanner(baseDir);
  log("Transforming into "+destDir, Project.MSG_INFO);

  TransformerFactory tFactory = null;
  try {
   tFactory = TransformerFactory.newInstance();
  } catch( Throwable e ) {
   String msg = "TrAX implementation not found!";
   throw new BuildException(msg);
  }

  long styleSheetLastModified = 0;
  if (transformFile != null) {
   styleSheetLastModified = transformFile.lastModified();
   log( "Loading stylesheet " + transformFile, Project.MSG_INFO);
  } else {
   String msg = "transform attribute must be set!";
   throw new BuildException( msg );
  }

  try {
   // Create a new XSL processor with the specified stylesheet
   transformer = tFactory
    .newTemplates( new StreamSource( transformFile ) )
    .newTransformer();
   log("Using TrAX interfaces for XSLT processing", Project.MSG_VERBOSE);
   String[] vars = env.getVariables();
   if( vars != null ) {
    for (int i = 0; i < vars.length; ++i) {
     int eIndex = vars[i].indexOf( '=' );
     transformer.setParameter(
      vars[i].substring( 0, eIndex ),
      vars[i].substring( eIndex + 1 )
     );
    }
   }
  } catch (Exception ex) {
   log("Failed to read stylesheet " + transformFile, Project.MSG_INFO);
   throw new BuildException(ex);
  }

  // Process all the files marked for styling
  list = scanner.getIncludedFiles();
  for (int i = 0;i < list.length; ++i) {
   process( baseDir, list[i], destDir, styleSheetLastModified );
  }

  // Process all the directoried 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, list[i], destDir, styleSheetLastModified );
  }
 } //  execute

 /**
  * Set the base directory.
 **/
 public void setBasedir(File dir) {
  baseDir = dir;
 } //  setSourceDir

 /**
  * Set the destination directory into which the XSL result
  * files should be copied to
  * @param dirName the name of the destination directory
 **/
 public void setDestdir(File dir) {
  destDir = dir;
 } //  setDestDir

 /**
  * Set the desired file extension to be used for the target
  * @param name the extension to use
 **/
 public void setExtension(String name) {
  targetExtension = name;
 } //  setDestDir

 /**
  * Sets the file to use for styling (*NOT* relative to baseDir).
  */
 public void setTransform(File file) {
  transformFile = file;
 }

 /**
  * Add a nested env element - an environment variable.
  */
 public void addEnv( Environment.Variable variable ) {
  env.addVariable( variable );
 }

 /**
  * Processes the given input XML file and stores the result
  * in the given resultFile.
 **/
 private void process(File baseDir, String xmlFile, File destDir,
       long styleSheetLastModified)
  throws BuildException {

  String fileExt=targetExtension;
  File   outFile=null;
  File   inFile=null;

  try {
   inFile = new File(baseDir,xmlFile);
   outFile = new
File(destDir,xmlFile.substring(0,xmlFile.lastIndexOf('.'))+fileExt);
   if (inFile.lastModified() > outFile.lastModified() ||
     styleSheetLastModified > outFile.lastModified()) {
    ensureDirectoryFor( outFile );
    //  command line status
    log("Processing " + xmlFile + " to " + outFile, Project.MSG_VERBOSE);
    transformer.transform(
     new StreamSource( inFile ),
     new StreamResult( outFile )
    );
   }
  }
  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);
   outFile.delete();
   throw new BuildException(ex);
  }

 } //  processXML

 private void ensureDirectoryFor( File targetFile ) throws BuildException {
  File directory = new File( targetFile.getParent() );
  if (!directory.exists()) {
   if (!directory.mkdirs()) {
    throw new BuildException("Unable to create directory: "
           + directory.getAbsolutePath() );
   }
  }
 }
} //  XSLTProcess2



Mime
View raw message