org.w3c.tidy.ant.JTidyTask Maven / Gradle / Ivy
/*
* Java HTML Tidy - JTidy
* HTML parser and pretty printer
*
* Copyright (c) 1998-2000 World Wide Web Consortium (Massachusetts
* Institute of Technology, Institut National de Recherche en
* Informatique et en Automatique, Keio University). All Rights
* Reserved.
*
* Contributing Author(s):
*
* Dave Raggett
* Andy Quick (translation to Java)
* Gary L Peskin (Java development)
* Sami Lempinen (release management)
* Fabrizio Giustina
*
* The contributing author(s) would like to thank all those who
* helped with testing, bug fixes, and patience. This wouldn't
* have been possible without all of you.
*
* COPYRIGHT NOTICE:
*
* This software and documentation is provided "as is," and
* the copyright holders and contributing author(s) make no
* representations or warranties, express or implied, including
* but not limited to, warranties of merchantability or fitness
* for any particular purpose or that the use of the software or
* documentation will not infringe any third party patents,
* copyrights, trademarks or other rights.
*
* The copyright holders and contributing author(s) will not be
* liable for any direct, indirect, special or consequential damages
* arising out of any use of the software or documentation, even if
* advised of the possibility of such damage.
*
* Permission is hereby granted to use, copy, modify, and distribute
* this source code, or portions hereof, documentation and executables,
* for any purpose, without fee, subject to the following restrictions:
*
* 1. The origin of this source code must not be misrepresented.
* 2. Altered versions must be plainly marked as such and must
* not be misrepresented as being the original source.
* 3. This Copyright notice may not be removed or altered from any
* source or altered source distribution.
*
* The copyright holders and contributing author(s) specifically
* permit, without fee, and encourage the use of this source code
* as a component for supporting the Hypertext Markup Language in
* commercial products. If you use this source code in a product,
* acknowledgment is not required but would be appreciated.
*
*/
package org.w3c.tidy.ant;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.Parameter;
import org.apache.tools.ant.util.FileNameMapper;
import org.apache.tools.ant.util.FlatFileNameMapper;
import org.apache.tools.ant.util.IdentityMapper;
import org.w3c.tidy.Tidy;
/**
* JTidy ant task.
* Parameters
*
* JTidy Ant Task
*
*
* Attribute
* Description
* Required
*
*
*
* srcfile
* source file
* Yes, unless a nested <fileset> element is used.
*
*
* destfile
* destination file for output
* With the srcfile attribute, either destfile or destdir
* can be used. With nested <fileset> elements only destdir is allowed.
*
*
* destdir
* destination directory for output
*
*
* properties
* Path to a valid tidy properties file
* No
*
*
* flatten
* Ignore the directory structure of the source files, and copy all files into the directory specified by the
* destdir attribute.
* No; defaults to false.
*
*
* failonerror
* boolean to control whether failure to execute should throw a BuildException or just print an error. If set to
* true errors in input files which tidy is enable to fix will cause a failure.
* No; defaults to false.
*
*
* Nested elements
*
* - Fileset : if you need to run tidy on more than one file, you can specify nested filesets.
* - Parameter : you can specify any tidy configuration option directly using a nested
*
parameter element.
*
* Setup
*
* Adds the following typedef to setup the JTidy task in your build.xml:
*
*
*
* <taskdef name="tidy" classname="org.w3c.tidy.ant.JTidyTask"/>
*
*
*
* This will work if JTidy jar is copied to ant lib directory. If you need to reference the jar elsewhere on the
* filesystem you can add a nested classpath element:
*
*
*
* <taskdef name="tidy" classname="org.w3c.tidy.ant.JTidyTask">
* <classpath>
* <pathelement location="${lib.dir}/jtidy.jar"/>
* </classpath>
* </taskdef>
*
*
* Examples
*
*
* <tidy destdir="out" properties="/path/to/tidy.properties">
* <fileset dir="inputdir" />
* <parameter name="drop-font-tags" value="true" />
* </tidy>
*
*
* @author Fabrizio Giustina
* @version $Revision$ ($Author$)
*/
public class JTidyTask extends Task
{
/**
* Filesets.
*/
private final List filesets = new ArrayList<>();
/**
* Destination directory for output.
*/
private File destdir;
/**
* Destination file for output.
*/
private File destfile;
/**
* Source file.
*/
private File srcfile;
/**
* Control whether failure to execute should throw a BuildException.
*/
private boolean failonerror;
/**
* Don't output directories.
*/
private boolean flatten;
/**
* tidy instance.
*/
private Tidy tidy;
/**
* Configured properties.
*/
private Properties props;
/**
* Properties file.
*/
private File properties;
/**
* @param destdir The destdir to set.
*/
public void setDestdir(File destdir)
{
this.destdir = destdir;
}
/**
* @param destfile The destfile to set.
*/
public void setDestfile(File destfile)
{
this.destfile = destfile;
}
/**
* @param srcfile The srcfile to set.
*/
public void setSrcfile(File srcfile)
{
this.srcfile = srcfile;
}
/**
* @param failonerror The failonerror to set.
*/
public void setFailonerror(boolean failonerror)
{
this.failonerror = failonerror;
}
/**
* @param flatten The flatten to set.
*/
public void setFlatten(boolean flatten)
{
this.flatten = flatten;
}
/**
* @param properties The properties to set.
*/
public void setProperties(File properties)
{
this.properties = properties;
}
/**
* Adds a fileset to be processed Fileset
*
* @param fileSet file-set to add
*/
public void addFileset(FileSet fileSet)
{
filesets.add(fileSet);
}
/**
* Setter method for any property using the ant type Parameter.
*
* @param prop Ant type Parameter
*/
public void addConfiguredParameter(Parameter prop)
{
props.setProperty(prop.getName(), prop.getValue());
}
/**
* Initializes the task.
*/
@Override
public void init()
{
super.init();
// Setup a Tidy instance
tidy = new Tidy();
props = new Properties();
}
/**
* Validates task parameters.
*
* @throws BuildException if any invalid parameter is found
*/
protected void validateParameters()
{
if (srcfile == null && filesets.isEmpty())
{
throw new BuildException("Specify at least srcfile or a fileset.");
}
if (srcfile != null && !filesets.isEmpty())
{
throw new BuildException("You can't specify both srcfile and nested filesets.");
}
if (destfile == null && destdir == null)
{
throw new BuildException("One of destfile or destdir must be set.");
}
if (srcfile == null && destfile != null)
{
throw new BuildException("You only can use destfile with srcfile.");
}
if (srcfile != null && srcfile.isDirectory())
{
throw new BuildException("srcfile can't be a directory.");
}
if (properties != null && ( !properties.exists() || properties.isDirectory()))
{
throw new BuildException("Invalid properties file specified: " + properties.getPath());
}
}
/**
* Run the task.
*
* @throws BuildException The exception raised during task execution.
*/
@Override
public void execute()
{
// validate
validateParameters();
// load configuration
if (this.properties != null)
{
try
{
this.props.load(new FileInputStream(this.properties));
}
catch (IOException e)
{
throw new BuildException("Unable to load properties file " + properties, e);
}
}
// hide output unless set in properties
tidy.setErrout(new PrintWriter(new ByteArrayOutputStream()));
tidy.setConfigurationFromProps(props);
if (this.srcfile != null)
{
// process a single file
executeSingle();
}
else
{
// process filesets
executeSet();
}
}
/**
* A single file has been specified.
*/
protected void executeSingle()
{
if (!srcfile.exists())
{
throw new BuildException("Could not find source file " + srcfile.getAbsolutePath() + ".");
}
if (destfile == null)
{
// destdir can't be null, condition is checked in validateParameters()
destfile = new File(destdir, srcfile.getName());
}
processFile(srcfile, destfile);
}
/**
* Run tidy on filesets.
*/
protected void executeSet()
{
FileNameMapper mapper = flatten ? new FlatFileNameMapper() : new IdentityMapper();
mapper.setTo(this.destdir.getAbsolutePath());
for (FileSet fileSet : filesets)
{
DirectoryScanner directoryScanner = fileSet.getDirectoryScanner(getProject());
String[] sourceFiles = directoryScanner.getIncludedFiles();
File inputdir = directoryScanner.getBasedir();
mapper.setFrom(inputdir.getAbsolutePath());
for (String sourceFile : sourceFiles)
{
String[] mapped = mapper.mapFileName(sourceFile);
processFile(new File(inputdir, sourceFile), new File(this.destdir, mapped[0]));
}
}
}
/**
* Run tidy on a file.
*
* @param inputFile input file
* @param outputFile output file
*/
protected void processFile(File inputFile, File outputFile)
{
log("Processing " + inputFile.getAbsolutePath(), Project.MSG_DEBUG);
try (InputStream is = new BufferedInputStream(new FileInputStream(inputFile)))
{
if (!outputFile.getParentFile().mkdirs() || !outputFile.createNewFile())
{
log("Existing output file " + outputFile, Project.MSG_DEBUG);
}
try (OutputStream os = new BufferedOutputStream(new FileOutputStream(outputFile)))
{
tidy.parse(is, os);
}
catch (IOException e)
{
throw new BuildException("Unable to process destination file " + outputFile, e);
}
}
catch (IOException e)
{
throw new BuildException("Unable to open file " + inputFile, e);
}
// cleanup empty files
if (tidy.getParseErrors() > 0 && !tidy.getForceOutput())
{
try
{
Files.delete(outputFile.toPath());
}
catch (IOException e)
{
throw new BuildException("Failed trying to delete output file " + outputFile, e);
}
}
if (failonerror && tidy.getParseErrors() > 0)
{
throw new BuildException("Tidy was unable to process file "
+ inputFile
+ ", "
+ tidy.getParseErrors()
+ " returned.");
}
}
}